{ "openapi": "3.0.0", "info": { "title": "The Pricefx Backend API", "version": "", "description": "Pricefx REST API Reference", "contact": { "email": "documentation@pricefx.com", "name": "Pricefx", "url": "https://www.pricefx.com" } }, "servers": [ { "url": "https://{baseUrl}/pricefx/{partition}", "description": "URL:", "variables": { "baseUrl": { "default": "companynode.pricefx.com", "description": "A domain name of your Pricefx instance." }, "partition": { "default": "companypartition", "description": "A name of the partition you want to use." } } } ], "paths": { "/loaddata/{TypeCode}": { "parameters": [ { "$ref": "#/components/parameters/TypeCode" } ], "post": { "summary": "Insert Bulk Data", "operationId": "post-loaddata-typecode", "responses": { "200": { "$ref": "#/components/responses/loaddataResponse" } }, "description": "Inserts multiple records to the Master Data table.

\n\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\nUse the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format (YYYY-MM-DD) if a date is included in the table.

\nSee the list of [bulk-loadable objects](https://pricefx.atlassian.net/wiki/spaces/KB/pages/5345214465/Bulk-Loadable+Objects).\n>If used in a Groovy logic, it is recommended to use the [api.addOrUpdate()](https://qa.pricefx.eu/pricefx-api/groovy/develop/net/pricefx/formulaengine/scripting/PublicGroovyAPI.html#addOrUpdate(java.lang.String,java.util.List)) method instead of this loaddata endpoint within the boundCall().
\n>For more details see the [Avoid api.boundCall](https://pricefx.atlassian.net/wiki/spaces/KB/pages/2511699985/Avoid+api.boundCall) article.\n

\n\n> **Please note**\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "tags": [ "General" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkDataRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "header", "data" ], "properties": { "header": { "description": "Specify header field names (table columns) of the record in the target table.", "type": "array", "items": {} }, "options": { "type": "object", "description": "Specify options of the bulk data insertion.", "properties": { "detectJoinFields": { "type": "boolean", "description": "Set to `true` to use join fields definitions from the server. Set to `false` to specify join fields with the `joinFields` parameter in the request." }, "joinFields": { "type": "array", "description": "A list of fields (that also need to appear in `header` and `data`) that make up the business key.", "items": { "type": "string" } }, "conditionRecords": { "type": "object", "description": "Options applicable only for the CRCP data load.", "properties": { "splicing": { "type": "object", "description": "Options applicable for splicing process of the Condition Records.", "properties": { "setFields": { "type": "object", "description": "A list of fields for set (sets the attribute to a specified value)." }, "resetFields": { "type": "array", "description": "A list of fields for reset (sets the attribute value to `NULL`).", "items": { "type": "string" } }, "supersedeRecords": { "type": "boolean", "default": false, "description": "When enabled (set to `true` / `ON`) , the Superseding function moves the Condition Records from `CRCI` to `CRCIH` (the Historical Tables for Conditional Record Items). By default, this feature is turned off (`false`) and can be activated only by turning it on." } } } } } }, "required": [ "detectJoinFields", "joinFields" ] }, "data": { "type": "array", "description": "Specify the field values in the same order as specified in the header object.", "items": { "type": "array", "items": {} } } } } }, "required": [ "data" ] }, "examples": { "insertBulkDataExample": { "value": { "data": { "header": [ "sku", "label", "unitOfMeasure", "currency" ], "options": { "detectJoinFields": false, "joinFields": [ "sku" ] }, "data": [ [ 11111, "Label One", "EA", "USD" ], [ 22222, "Label Two", "EA", "EUR" ], [ 33333, "Label Three", "EA", "CZK" ] ] } } } } } }, "description": "The **`/loaddata/P`** endpoint (Insert Bulk Products) is used in our example.

\n\n> **Information**:\n>Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/AM`** (AttributeMeta) endpoint, for example, use **`/fetch/RBTAM`** to retrieve Rebate Type attribute fields." } } }, "/loaddata.file/{TypeCode}": { "parameters": [ { "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to insert a data to. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article.", "schema": { "type": "string", "enum": [ "C", "CDESC", "CX", "JLTV", "LTV", "MLTV", "P", "PBOME", "PCOMP", "PDESC", "PR", "PX", "PXREF", "SL", "SX", "TODO", "UG" ], "example": "PX" } } ], "post": { "summary": "Insert Bulk Data From a File", "operationId": "post-loaddata.file-typecode", "description": "Inserts multiple records to the Master Data table from the CSV file.

\n\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\n>If used in a Groovy logic, it is recommended to use the [api.addOrUpdate()](https://qa.pricefx.eu/pricefx-api/groovy/develop/net/pricefx/formulaengine/scripting/PublicGroovyAPI.html#addOrUpdate(java.lang.String,java.util.List)) method instead of this loaddata endpoint within the boundCall().
\n>For more details see the [Avoid api.boundCall](https://pricefx.atlassian.net/wiki/spaces/KB/pages/2511699985/Avoid+api.boundCall) article.\n

\n\n\n> **Please note**\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata.file** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "tags": [ "General" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "name", "description": "The name of the table you want to upload a file to." } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "title": "insertBulkDataFromFileRequest", "properties": { "fileName": { "type": "string", "format": "binary", "description": "Provide a file in the CSV format. The file must also contain the `name` column with the name(s) of the table (PX, CX, SX) you are inserting the records to." }, "joinFields": { "type": "string", "description": "Specify fields that make up a Business key." } }, "required": [ "fileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "insertBulkDataFromFileResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uploadStatusId": { "type": "integer" }, "loadedRecords": { "type": "integer" }, "invalidRecords": { "type": "integer" }, "totalRecords": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "insertBulkDataFromFileResponseExample": { "value": { "response": { "node": "node", "data": [ { "uploadStatusId": 4306, "loadedRecords": 4, "invalidRecords": 0, "totalRecords": 4 } ], "status": 0 } } } } } } } } } }, "/loaddata.file/{TypeCode}/async": { "parameters": [ { "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to insert a data to. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article.", "schema": { "type": "string", "enum": [ "C", "CDESC", "CX", "JLTV", "LTV", "MLTV", "P", "PBOME", "PCOMP", "PDESC", "PR", "PX", "PXREF", "SL", "SX", "TODO", "UG" ], "example": "PX" } } ], "post": { "summary": "Insert Bulk Data From a File (async)", "operationId": "post-loaddata.file-typecode-async", "description": "Creates a JST job (the `LOADDATA_FILE` type) for inserting multiple records to the Master Data table from a CSV file.

\nYou can get the status of the job by calling the `admin.fetchjst/{jstId}` endpoint. The `jstId` can be found in the response of the `/loaddata.file/{TypeCode}/async` endpoint.
Allows parallel loaddata calls. You can also view the job in **Administration** > **Logs** > **Jobs & Tasks**.\n\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\n>If used in a Groovy logic, it is recommended to use the [api.addOrUpdate()](https://qa.pricefx.eu/pricefx-api/groovy/develop/net/pricefx/formulaengine/scripting/PublicGroovyAPI.html#addOrUpdate(java.lang.String,java.util.List)) method instead of this loaddata endpoint within the boundCall().
\n>For more details see the [Avoid api.boundCall](https://pricefx.atlassian.net/wiki/spaces/KB/pages/2511699985/Avoid+api.boundCall) article.\n

\n\n\n> **Please note**\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata.file** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "tags": [ "General" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "name", "description": "The name of the table you want to upload a file to." } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "title": "insertBulkDataFromFileAsyncRequest", "properties": { "fileName": { "type": "string", "format": "binary", "description": "Provide a file in the CSV format. The file must also contain the `name` column with the name(s) of the table (PX, CX, SX) you are inserting the records to." }, "joinFields": { "type": "string", "description": "Specify fields that make up a Business key." } }, "required": [ "fileName" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "insertBulkDataFromFileAsyncResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "uploadStatusId": { "type": "integer" }, "jstId": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "insertBulkDataFromFileAsyncResponseExample": { "value": { "response": { "node": "node", "data": [ { "uploadStatusId": 4296, "jstId": 2148038471 } ], "status": 0 } } } } } } } } } }, "/loaddata/P": { "post": { "summary": "Insert Bulk Products", "operationId": "post-loaddata-P", "responses": { "200": { "$ref": "#/components/responses/loaddataResponse" }, "400": { "description": "Bad Request - Invalid command parameters" } }, "description": "Inserts multiple products to the Master Data table.

\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\nUse the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format (YYYY-MM-DD) if a date is included in the table.\n\n>**Please note**:\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkProductsRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "header", "data" ], "properties": { "header": { "type": "array", "description": "Specify header field names (table columns) of the record in the target table.", "items": { "type": "string" } }, "options": { "type": "object", "description": "Specify options of the bulk data insertion.", "properties": { "detectJoinFields": { "type": "boolean", "description": "Set to `true` to use join fields definitions from the server. Set to `false` to specify join fields with the `joinFields` parameter in the request.\n" } } }, "data": { "type": "array", "description": "Specify the field values in the same order as specified in the header object.", "items": { "type": "array", "items": {} } } } } }, "required": [ "data" ] }, "examples": { "productLoaddataRequest": { "value": { "data": { "header": [ "sku", "label", "unitOfMeasure", "currency", "lastUpdateDate", "formulaName", "attribute1", "attribute2", "attribute3", "attribute4", "attribute5", "attribute6", "attribute7", "attribute8", "userGroupEdit", "userGroupViewDetails" ], "options": { "detectJoinFields": true }, "data": [ [ "B-0001", "Pub Beer", "", "EUR", "2020-12-17T09:45:56", "ElementWithVLookup", "17.16", "American Pale Lager", "", "", "DG_03", "Maturity", "", "2018-04-18", "", "" ], [ "B-0002", "Devil's Cup", "", "EUR", "2022-10-07T09:43:30", "", "24.05", "American Pale Ale (APA)", "", "", "DG_03", "Maturity", "", "2018-04-18", "", "" ], [ "B-0003", "Rise of the Phoenix", "", "EUR", "2019-07-15T11:18:26", "ConfiguratorWithRadioButton", "34.4", "American IPA", "", "A", "DG_03", "", "", "2018-04-18", "", "" ] ] } } } } } }, "description": "Specify product field names in the `header` object and fields values in the `data` object.

\n\n>**Information**: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/PAM`** endpoint." }, "parameters": [], "tags": [ "Products" ] } }, "/loaddata/PX": { "post": { "summary": "Insert Bulk Product Extensions", "operationId": "post-loaddata-PX", "responses": { "200": { "description": "OK" } }, "description": "Inserts multiple product extensions to the Master Data table.

\nThe `name` (a name of the category) and `sku` must be provided for each record in the header and data object within the request body.\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\nUse the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format (YYYY-MM-DD) if a date is included in the table.\n\n\n>**Please note**:\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.\n\n---", "tags": [ "Product Extensions" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkProductExtensionsRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "data", "header" ], "properties": { "data": { "type": "array", "description": "The data fields. Appearing in same order as specified in `header` list.", "items": {} }, "header": { "type": "array", "description": "The header fields.", "items": {} }, "options": { "type": "object", "properties": { "detectJoinFields": { "type": "boolean", "default": true }, "joinFields": { "type": "array", "description": "A list of fields (that also need to appear in `header` and `data) that make up the business key.", "items": { "type": "string" } } } } } } }, "required": [ "data" ] }, "examples": { "productextensionLoaddataRequest": { "value": { "data": { "data": [ [ "p0006028005", "Products" ], [ "p0006047451", "Products" ], [ "p0006056838", "Products" ], [ "p0000412926", "Products" ], [ "p0000014471", "Products" ], [ "p0000412891", "Products" ] ], "header": [ "sku", "name" ], "options": { "detectJoinFields": false, "joinFields": [ "sku", "name" ] } } } } } } }, "description": "Specify product extension field names in the `header` object and field values in the `data` object." } } }, "/loaddata/SX": { "post": { "summary": "Insert Bulk Seller Extensions", "operationId": "post-loaddata-SX", "responses": { "200": { "description": "OK" } }, "description": "Inserts multiple product extensions to the Master Data table.

\nThe `name` (a name of the category) and `sku` must be provided for each record in the header and data object within the request body.\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\nUse the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) date format (YYYY-MM-DD) if a date is included in the table.\n\n\n>**Please note**:\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkProductExtensionsRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "data", "header" ], "properties": { "data": { "type": "array", "description": "The data fields. Appearing in same order as specified in header list", "items": {} }, "header": { "type": "array", "description": "The header fields.", "items": {} }, "options": { "type": "object", "properties": { "detectJoinFields": { "type": "boolean", "default": true }, "joinFields": { "type": "array", "description": "A list of fields (that also need to appear in `header` and `data`) that make up the business key.", "items": { "type": "string" } } } } } } }, "required": [ "data" ] }, "examples": { "sellerextensionLoaddataRequest": { "value": { "data": { "data": [ [ "s0006028005", "SXTest2" ], [ "s0006047451", "SXTest2" ], [ "s0006056838", "SXTest2" ], [ "s0000412926", "SXTest2" ], [ "s0000014471", "SXTest2" ], [ "s0000412891", "SXTest2" ] ], "header": [ "sellerId", "name" ], "options": { "detectJoinFields": false, "joinFields": [ "sellerId", "name" ] } } } } } } }, "description": "Specify seller extension field names in the `header` object and field values in the `data` object." }, "tags": [ "Seller Extensions" ] }, "parameters": [] }, "/loaddata/C": { "post": { "summary": "Insert Bulk Customers", "operationId": "post-loaddata-C", "responses": { "200": { "$ref": "#/components/responses/loaddataResponse" } }, "description": "Inserts multiple customers to the Master Data table.

\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\n\n>**Please note**\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "tags": [ "Customers" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkCustomersRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "header", "data" ], "properties": { "header": { "type": "array", "items": { "type": "string" } }, "options": { "type": "object", "properties": { "detectJoinFields": { "type": "boolean" } } }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "data" ] }, "examples": { "customerLoaddataRequest": { "value": { "data": { "header": [ "customerId", "name", "attribute1", "attribute2" ], "options": { "detectJoinFields": true }, "data": [ [ "00001", "John Doe", "The Street 11, NY", "123456789" ], [ "00002", "Tom Jones", "High Street 23, London", "123456789" ], [ "00003", "Kate Smith", "Derry Lane", "123456789" ] ] } } } } } }, "description": "Specify customer field names in the `header` object and fields values in the `data` object.

\n\n>**Information**: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/CAM`** endpoint." } } }, "/loaddata/CX": { "post": { "summary": "Insert Bulk Customer Extensions", "operationId": "post-loaddata-CX", "responses": { "200": { "$ref": "#/components/responses/loaddataResponse" } }, "description": "Inserts multiple customers extensions to the Master Data table.

\nThe `name` (a name of the category) and `customerId` must be provided for each record in the header and data object within the request body.\n\nThe **/loaddata** operation is a very efficient and quick way to insert bulk data to the Master Data table.\nThe main advantage is its greater speed when loading thousands of records (compared to e.g. **/integrate**).

\n\n>**Please note**\n> If no `joinFields` are provided in the request, then this operation will insert entire records. It means that in this case (without `joinFields`) with **/loaddata** it is not possible to update just some fields (for this use the **/integrate** endpoint instead). The source data must always contain the entire row’s content.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkCustomerExtensionsRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "data", "header" ], "properties": { "data": { "type": "array", "description": "Specify the field values in the same order as specified in the header object.", "items": {} }, "header": { "description": "efine field names (table columns) of the record.", "type": "array", "items": {} }, "options": { "type": "object", "properties": { "detectJoinFields": { "type": "boolean" }, "joinFields": { "type": "array", "description": "A list of fields (that also need to appear in the header and data) that make up the business key", "items": { "type": "string" } } } } } } }, "required": [ "data" ] }, "examples": { "customerextensionLoaddataRequest": { "value": { "data": { "data": [ [ "0006028005", "Customer001" ], [ "0006047451", "Customer001" ], [ "0006056838", "Customer001" ], [ "0000412926", "Customer001" ], [ "0000014471", "Customer001" ], [ "0000412891", "Customer001" ] ], "header": [ "customerId", "name" ], "options": { "detectJoinFields": false, "joinFields": [ "customerId", "name" ] } } } } } } }, "description": "Specify customer extension field names in the `header` object and field values in the `data` object.

\n\n>**Information**: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/CXAM`** endpoint." }, "tags": [ "Customer Extensions" ] } }, "/integrate/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "ACTT", "AP", "APIK", "BD", "BPT", "BR", "C", "CA", "CAM", "CDESC", "CF", "CFS", "CFT", "CH", "CLLI", "CN", "CS", "CT", "CTAM", "CTLI", "CTMU", "CTMUI", "CTT", "CTTAM", "CTTREE", "CW", "CX", "CXAM", "DA", "DB", "DCR", "DCRAM", "DCRI", "DCRL", "DCRMC", "DCRT", "DE", "DI", "DM", "DMDC", "DMDL", "DMDS", "DMF", "DMM", "DMR", "DMT", "DREG", "DWT", "ET", "EVT", "F", "FE", "FN", "IDC", "IE", "ISH", "JST", "JLTV", "JLTVM", "LAT", "LT", "LTT", "LTV", "M", "MLTV", "MLTV2", "MLTV3", "MLTV4", "MLTV5", "MLTV6", "MLTVM", "MPL", "MPLAM", "MPLI", "MPLIT", "MPLT", "MR", "MRAM", "MT", "P", "PAM", "PAPIJ", "PBOME", "PCOMP", "PCW", "PDESC", "PG", "PGI", "PGIM", "PGT", "PH", "PL", "PLI", "PLIM", "PLT", "PR", "PRAM", "PREF", "PT", "PWH", "PX", "PXAM", "PXREF", "PYR", "PYRAM", "Q", "QAM", "QLI", "QMU", "QMUI", "QT", "QTT", "QTTAM", "R", "RAT", "RATM", "RBA", "RBAAM", "RBALI", "RBAT", "RBT", "RBTAM", "RR", "RRAM", "RRS", "RRSC", "RT", "SAT", "SC", "SCN", "SCNAM", "SCT", "SIAM", "SIM", "SIMI", "TFA", "TODO", "U", "UG", "US", "W", "WD", "WF", "WFE", "XPGI", "XPLI", "XSIMI" ], "example": "P" }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the Type code of the entity you want to insert a data to. See [the list of Type codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article." } ], "post": { "summary": "Upsert an Object", "operationId": "post-integrate-TypeCode", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Upserts an object (the object type must be specified by *Type Code* in the path).

\nTo *add* a new object that does not exist, specify the `sku` parameter in the request.

\nTo *update* an existing object, specify the `sku` or `typedId` parameter of the *existing* object. The **`/integrate`** method performs a partial update – it does not delete field values that have not been specified in the update request.\n\n\n>**Please note**\n>This method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes.\n>To insert more objects in bulk, please use the **`/loaddata/{TypeCode}`** endpoint.\n\n\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n\n>**Information**\n>You can upsert multiple records using one request. To do so, add multiple `data` objects into your JSON. See the example below.\n```json\n[\n {\n \"data\": {\n \"sku\": \"111111\",\n \"typedId\": \"2147501227.P\",\n \"label\": \"The New Label\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"USD\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n },\n {\n \"data\": {\n \"sku\": \"222222\",\n \"label\": \"The New Label 2\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"EUR\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n }\n]\n```", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertObjectRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku" ], "description": "Specify field names and values you want to insert or update.", "properties": { "sku": { "type": "string", "minLength": 1 }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "upsertProductRequestExample": { "value": { "data": { "sku": "111111", "typedId": "2147501227.P", "label": "The New Label", "unitOfMeasure": "EA", "currency": "USD", "formulaName": "priceLogic2", "attribute1": "1", "attribute2": "2", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers" } } } } } }, "description": "The **`/integrate/P`** endpoint (Upsert a Product) is used in our example.

\n\n>**Information**: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/AM`** (AttributeMeta) endpoint, for example, use **`/fetch/RBTAM`** to retrieve Rebate Type attribute fields." }, "tags": [ "General" ] } }, "/integrate/{TypeCode}/returnolddata": { "parameters": [ { "$ref": "#/components/parameters/TypeCode" } ], "post": { "summary": "Upsert an Object (and return old data)", "operationId": "post-integrate-TypeCode-oldData", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "upsertObjectReturnOldDataResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "oldData": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 } }, "required": [ "version", "typedId", "sku", "label", "unitOfMeasure", "userGroupEdit", "userGroupViewDetails", "currency", "formulaName", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2" ] }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "sku", "label", "unitOfMeasure", "userGroupEdit", "userGroupViewDetails", "currency", "formulaName", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "image": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } } }, "status": { "type": "number" } }, "required": [ "node", "oldData", "csrfToken", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "upsertObjectOldDataResponse": { "value": { "response": { "node": "", "oldData": { "version": 6, "typedId": "2147501226.P", "sku": "xxxxxx5", "label": "The New Label4", "unitOfMeasure": "EA", "userGroupEdit": "Administrators", "userGroupViewDetails": "Administrators", "currency": "EUR", "formulaName": "priceLogic2", "createDate": "2021-09-16T12:31:18", "createdBy": 2147490696, "lastUpdateDate": "2021-09-17T08:40:33", "lastUpdateBy": 2147490696, "attribute1": "1", "attribute2": "2" }, "csrfToken": "", "data": [ { "version": 7, "typedId": "2147501226.P", "sku": "xxxxxx5", "label": "The New Label4", "unitOfMeasure": "EA", "userGroupEdit": "Administrators", "userGroupViewDetails": "Administrators", "currency": "EUR", "formulaName": "priceLogic2", "image": null, "createDate": "2021-09-16T12:31:18", "createdBy": 2147490696, "lastUpdateDate": "2021-09-17T08:41:11", "lastUpdateBy": 2147490696, "attribute1": "1", "attribute2": "2", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "description": "Upserts an object (the object type must be specified by *Type Code* in the path) and returns record details of the previous version. It allows you to check changes in the record.

\nTo *add* a new object that does not exist, specify the `sku` parameter in the request.

\nTo *update* an existing object, specify the `sku` or `typedId` parameter of the *existing* object. The **`/integrate`** method performs a partial update – it does not delete values from fields that have not been specified in the update request.\n\n---\n\n>**Please note**:\n>This method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes.\n>To insert more objects in bulk please use the **`/loaddata/{TypeCode}`** endpoint.\n\n---\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n\n>**Information**:\n>You can upsert multiple records using one request. To do so, add multiple `data` objects into your JSON. See the example below.\n```json\n[\n {\n \"data\": {\n \"sku\": \"111111\",\n \"typedId\": \"2147501227.P\",\n \"label\": \"The New Label\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"USD\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n },\n {\n \"data\": {\n \"sku\": \"222222\",\n \"label\": \"The New Label 2\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"EUR\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n }\n]\n```\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertObjectReturnOldDataRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku" ], "description": "Specify field names and values you want to insert or update.", "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "upsertProductRequestExample": { "value": { "data": { "sku": "111111", "typedId": "2147501227.P", "label": "The New Label", "unitOfMeasure": "EA", "currency": "USD", "formulaName": "priceLogic2", "attribute1": "1", "attribute2": "2", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers" } } } } } }, "description": "The **`/integrate/P/returnolddata`** endpoint (upserts a product) is used in our example.

\n**Please note**: Field names (columns) sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/PAM`** endpoint." }, "tags": [ "General" ] } }, "/integrate/P": { "parameters": [], "post": { "summary": "Upsert a Product", "operationId": "post-integrate-type-code", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Upserts a product.

\n- To *add* a new product that does not exist, specify the `sku` parameter in the request.

\n- To *update* an existing product, specify the `sku` or `typedId` parameter of the *existing* product. The **`/integrate`** method performs a partial update – it does not delete values from fields that have not been specified in the update request.

\nUse the **`/integrate/{TypeCode}/returnolddata`** endpoint to return also the data of the previous version in the response.\n\n---\n\n> **Please note**:\n>This method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes.\n>To work with more products in bulk please use the **`/loaddata/P`** endpoint.\n\n---\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n\n>**Information**:\n>You can upsert multiple records using one request. To do so, add multiple `data` objects into your JSON. See the example below.\n```json\n[\n {\n \"data\": {\n \"sku\": \"111111\",\n \"typedId\": \"2147501227.P\",\n \"label\": \"The New Label\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"USD\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n },\n {\n \"data\": {\n \"sku\": \"222222\",\n \"label\": \"The New Label 2\",\n \"unitOfMeasure\": \"EA\",\n \"currency\": \"EUR\",\n \"formulaName\": \"priceLogic2\",\n \"attribute1\": \"1\",\n \"attribute2\": \"2\",\n \"userGroupEdit\": \"Administrators\",\n \"userGroupViewDetails\": \"PricingManagers\"\n }\n }\n]\n```\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertProductRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku" ], "description": "Specify field names and values you want to insert or update.", "properties": { "sku": { "type": "string", "minLength": 1, "maxLength": 255 }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "currency": { "type": "string", "minLength": 1, "maxLength": 255 }, "formulaName": { "type": "string", "minLength": 1, "maxLength": 255 }, "userGroupEdit": { "type": "string", "minLength": 1, "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "minLength": 1, "maxLength": 255 }, "attribute1": { "type": "string", "minLength": 1, "maxLength": 255 }, "attribute2": { "type": "string", "minLength": 1, "maxLength": 255 } } } }, "required": [ "data" ] }, "examples": { "upsertProductExample": { "value": { "data": { "sku": "123456", "typedId": "2147501227.P", "label": "The Label", "unitOfMeasure": "EA", "currency": "USD", "formulaName": "PricingFormula01", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers", "attribute1": "20", "attribute2": "10" } } } } } }, "description": "Either `sku` or `typedId` must be specified in order to *update* an existing product.\nTo insert a *new* product, specify at least the `sku` parameter.

\n\n>**Please note**: The data sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/PAM`** operation." }, "tags": [ "Products" ] } }, "/integrate/C": { "post": { "summary": "Upsert a Customer", "operationId": "post-integrate-C", "responses": { "200": { "$ref": "#/components/responses/customerResponse" } }, "description": "Updates or creates a customer.

\nTo *add* a new customer that does not exist, specify the `customerId` parameter in the request.

\nTo *update* an existing customer, specify the `customerId` or `typedId` parameter of the *existing* customer. The **`/integrate`** method performs a partial update – it does not delete values from fields that have not been specified in the update request.

\nUse the **`/integrate/{TypeCode}/returnolddata`** endpoint to return also the data of the previous version in the response.\n\n\n>**Please note**:\n>This method is intended to be used with one or two objects and it allows you to update particular fields. >The request will overwrite the existing data of the record being updated, regardless of other changes.\n>To work with more customers in bulk please use the **`/loaddata/C`** endpoint.\n\n---\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n\n>**Information**:\n>You can upsert multiple records using within request. To do so, add multiple `data` objects into your JSON. See the example below.\n```json\n[\n {\n \"data\": {\n \"name\": \"The Customer\",\n \"customerId\": \"c00001\",\n \"attribute1\": \"High Street 23, London\"\n }\n },\n {\n \"data\": {\n \"name\": \"The Customer 02\",\n \"customerId\": \"c00002\",\n \"attribute1\": \"Low Street 161, Chicago\"\n }\n }\n]\n```\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertCustomerRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "name", "customerId" ], "properties": { "name": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "UpsertCustomerExample": { "value": { "data": { "name": "Customer001", "customerId": "2912.CX3", "attribute1": "High Street 333, London" } } } } } }, "description": "If the customer does not exist yet, at least the `customerId` must be specified in the payload.

\n**Please note**: The data sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/CAM`** operation." }, "tags": [ "Customers" ] } }, "/integrate/CX": { "post": { "summary": "Upsert a Customer Extension", "operationId": "post-integrate-CX", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "upsertCustomerExtensionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "customerId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": {}, "attribute3": {} } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "upsertCustomerExtensionResponse": { "value": { "response": { "node": "", "csrfToken": "", "data": [ { "version": 2, "typedId": "2912.CX3", "name": "Customer001", "customerId": "c00001", "createDate": "2021-09-21T15:53:20", "createdBy": 2147490696, "lastUpdateDate": "2021-09-21T16:00:14", "lastUpdateBy": 2147490696, "attribute1": "High Street 333, London", "attribute2": null, "attribute3": null } ], "status": 0 } } } } } } } }, "description": "Updates or creates a customer extension.

\nTo *add* a new customer extension that does not exist, specify the `customerId` and `name` parameter in the request.

\nTo *update* an existing customer extension, specify the `name` and `customerId` or `typedId` parameters of the *existing* customer extension. The **`/integrate`** method performs a partial update – it does not delete values from fields that have not been specified in the update request.

\nUse the **`/integrate/{TypeCode}/returnolddata`** endpoint to return also the data of the previous version in the response.\n\n---\n**Please note**\n\nThis method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes.\nTo work with more customers in bulk please use the **`/loaddata/C`** endpoint.\n\n---\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n---\n**Information**\n\nYou can upsert multiple records using within request. To do so, add multiple `data` objects into your JSON. See the **batchUpsertCustomerExample** example.\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertCustomerExtensionRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "name", "customerId" ], "properties": { "name": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "upsertCustomerExtensionRequest": { "value": { "data": { "name": "Customer001", "customerId": "c00001", "attribute1": "High Street 333, London" } } } } } }, "description": "**Please note**: The data sent in your request might be different from our sample request schema. Custom fields (`attribute1`..`attribute30`) can be retrieved using the **`/fetch/CXAM`** operation." }, "tags": [ "Customer Extensions" ] } }, "/add/C": { "post": { "summary": "Add a Customer", "operationId": "post-add-C", "responses": { "200": { "$ref": "#/components/responses/customerResponse" } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addCustomerRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "customerId" ], "properties": { "customerId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 } } }, "operation": { "type": "string", "minLength": 1 } }, "required": [ "data", "operation" ] }, "examples": { "addCustomerRequest": { "value": { "data": { "customerId": "123456", "name": "Acme", "attribute1": "High Street 23", "attribute2": "+44 12345678", "userGroupEdit": "Administrators" }, "operation": "add" } } } } } }, "description": "Inserts a customer to the Master Data - Customers table.

\n**Please note**: The data sent in your request might be different from our sample request schema. The custom fields (`attribute1`..`attribute30`) can be retrieved using the **/fetch/CAM** operation.", "tags": [ "Customers" ] } }, "/add/P": { "post": { "summary": "Add a Product", "operationId": "post-add-P", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Inserts a product to the Master Data - Products table.", "tags": [ "Products" ], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addProductRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": { "type": "number" }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 } } }, "operation": { "type": "string", "minLength": 1 } }, "required": [ "data", "operation" ] }, "examples": { "addProductRequest Example": { "value": { "data": { "sku": "p2398759575012555", "label": "Smoked Tofu", "unitOfMeasure": "ea", "currency": "USD", "formulaName": "PriceList", "attribute1": "2", "attribute2": "PG1", "attribute3": 1, "userGroupEdit": "PricingManagers,Administrators", "userGroupViewDetails": "PricingManagers" }, "operation": "add" } } } } } } } }, "/update/P": { "post": { "tags": [ "Products" ], "summary": "Update a Product", "operationId": "post-update-P", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Updates an existing product.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateProductRequest", "type": "object", "properties": { "data": { "type": "object", "description": "Enter new field values. Multiple values can be updated. In our example the unitOfMeasure and label properties were updated.", "required": [ "typedId" ], "properties": { "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1, "maxLength": 255 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "userGroupEdit": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "currency": { "type": "string", "minLength": 1, "maxLength": 255 }, "formulaName": {}, "image": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } }, "operationType": { "type": "string", "minLength": 1, "description": "Must be 'update' or null or omitted." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "noEvent": { "type": "string", "description": "Set to `true` when this operation should NOT trigger an update event (where applicable)." } }, "required": [ "data", "oldValues" ] }, "examples": { "updateRequestExample": { "value": { "data": { "currency": "EUR", "typedId": "2147501222.P" }, "oldValues": { "version": 5, "typedId": "2147501222.P", "sku": "33333", "label": "Label Three", "unitOfMeasure": "EA", "userGroupEdit": "admin", "userGroupViewDetails": null, "currency": "CZK", "formulaName": "PriceList", "image": null, "createDate": "2021-09-16T09:43:59", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:33:16", "lastUpdateBy": 2147490696, "attribute1": "56", "attribute2": "3rd", "attribute3": 4, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "Updates specified fields of the record. Only one record can be updated per request (unless batched).

\n\n>**Please note**:\n>The update request should contain all old values in the `oldValues` property (especially the `typedId` and the `version`) and all values (along the typedId) you want to update in the `data` property.

\nApart from the version checks, additional integrity checks are performed. E.g. if fields that are part of the business key are changed then it is checked that no other object is already defined with those key(s)." } } }, "/update/{TypeCode}/returnolddata": { "post": { "summary": "Update an Object (and return old data)", "operationId": "post-update-typecode-returnolddata", "description": "Updates an existing object and returns details of the previous version. Updates specified fields (in the `data` property) of the record. Only one record can be updated per request (unless batched).

\n", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateObjectReturnOldDataRequest", "type": "object", "properties": { "data": { "type": "object", "description": "Enter new field values. Multiple values can be updated. In our example the unitOfMeasure and label properties were updated.", "required": [ "typedId" ], "properties": { "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId" ], "description": "Values of the object before the update. Especially important are `typedId` (to identify the object to update) and `version` (to detect date inconsistencies).", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1, "maxLength": 255 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "userGroupEdit": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "currency": { "type": "string", "minLength": 1, "maxLength": 255 }, "formulaName": {}, "image": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } }, "operationType": { "type": "string", "minLength": 1, "description": "Must be 'update' or null or omitted." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "noEvent": { "type": "string", "description": "Set to `true` when this operation should NOT trigger an update event (where applicable)." } }, "required": [ "data", "oldValues" ] }, "examples": { "updateRequestExample": { "value": { "data": { "currency": "EUR", "typedId": "2147501222.P" }, "oldValues": { "version": 5, "typedId": "2147501222.P", "sku": "33333", "label": "Label Three", "unitOfMeasure": "EA", "userGroupEdit": "admin", "userGroupViewDetails": null, "currency": "CZK", "formulaName": "PriceList", "image": null, "createDate": "2021-09-16T09:43:59", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:33:16", "lastUpdateBy": 2147490696, "attribute1": "56", "attribute2": "3rd", "attribute3": 4, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "\n>**Please note**:\n>The update request should contain all old values in the `oldValues` property (especially the `typedId` and the `version`) and all values (along the `typedId`) you want to update in the `data` property.

\nApart from the version checks, additional integrity checks are performed. E.g. if fields that are part of the business key are changed then it is checked that no other object already is defined with those key(s)." }, "tags": [ "General" ], "responses": { "200": { "description": "OK - contains the updated object and details of the previous version." } } }, "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ] }, "/update/{TypeCode}": { "post": { "summary": "Update an Object", "operationId": "post-update-typecode", "description": "Updates an existing object.
\nSpecify fields you want to update in the `data` property. Only one record can be updated per request (unless batched).\n", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateObjectRequest", "type": "object", "properties": { "data": { "type": "object", "description": "Enter new field values. Multiple values can be updated. In our example the unitOfMeasure and label properties were updated.", "required": [ "typedId" ], "properties": { "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId" ], "description": "Values of the object before the update. Especially important are `typedId` (to identify the object to update) and `version` (to detect date inconsistencies).", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1, "maxLength": 255 }, "label": { "type": "string", "minLength": 1, "maxLength": 255 }, "unitOfMeasure": { "type": "string", "minLength": 1, "maxLength": 255 }, "userGroupEdit": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true }, "currency": { "type": "string", "minLength": 1, "maxLength": 255 }, "formulaName": {}, "image": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } }, "operationType": { "type": "string", "minLength": 1, "description": "Must be 'update' or null or omitted." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "noEvent": { "type": "string", "description": "Set to `true` when this operation should NOT trigger an update event (where applicable)." } }, "required": [ "data", "oldValues" ] }, "examples": { "updateRequestExample": { "value": { "data": { "unitOfMeasure": "EA", "typedId": "2147501222.P" }, "oldValues": { "version": 5, "typedId": "2147501222.P", "sku": "33333", "label": "Label Three", "unitOfMeasure": "EA", "userGroupEdit": "admin", "userGroupViewDetails": null, "currency": "CZK", "formulaName": "PriceList", "image": null, "createDate": "2021-09-16T09:43:59", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:33:16", "lastUpdateBy": 2147490696, "attribute1": "56", "attribute2": "3rd", "attribute3": 4, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "\n>**Please note**:\n>The update request should contain all old values in the `oldValues` property (especially the `typedId` and the `version`) and all values (along the `typedId`) you want to update in the `data` property.

\nApart from the version checks, additional integrity checks are performed. E.g. if fields that are part of the business key are changed then it is checked that no other object already is defined with those key(s)." }, "tags": [ "General" ], "responses": { "200": { "description": "OK - contains the updated object." } } }, "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ] }, "/productmanager.quicksearch": { "post": { "summary": "Search a Product", "operationId": "post-productmanager.quicksearch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "searchProductResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "itemTypedId": { "type": "string", "minLength": 1 }, "listId": { "type": "number" }, "targetObjectTypeCode": { "type": "string", "minLength": 1 }, "listLabel": { "type": "string", "minLength": 1 } } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "searchProductRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "q" ], "properties": { "q": { "type": "string", "minLength": 1, "description": "Enter the term you want to search." } } } }, "required": [ "data" ] }, "examples": { "searchProductRequestExample": { "value": { "data": { "q": "PROD0001" } } } } } } }, "tags": [ "Products" ], "description": "Performs a search by `sku` and `label` fields. Returns all lists containing the search term. Enter the search term in the request body in the `q` parameter.\n\n> **Information**: Use the **/productmanager.quicksearch/{query}** (*Search a Product (URL)*) endpoint to pass the search term in the URL.\n" } }, "/productmanager.quicksearch/{query}": { "parameters": [ { "schema": { "type": "string" }, "name": "query", "in": "path", "required": true } ], "post": { "summary": "Search a Product (URL)", "operationId": "post-productmanager.quicksearch-query", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "searchProductURLResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "itemTypedId": { "type": "string", "minLength": 1 }, "listId": { "type": "number" }, "targetObjectTypeCode": { "type": "string", "minLength": 1 }, "listLabel": { "type": "string", "minLength": 1 } } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Products" ], "description": "Performs a search by `sku` and `label` fields. Returns all lists containing the search term. Enter the search term query [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.ASP) to prevent an invalid API call when using special characters in the URL.\n\n> **Information**: Use the **/productmanager.quicksearch** (*Search a Product*) endpoint to pass the search term in the request body." } }, "/productmanager.fetchformulafilteredproducts": { "post": { "summary": "List Products", "operationId": "post-productmanager.fetchformulafilteredproducts", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "tags": [ "Products" ], "description": "Retrieves a list of Products. A filter can be applied (see the request example).

\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the **listProductsResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the **listProductsResponseExample_valueFields** response example.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listProductsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1, "enum": [ "startsWith", "exact", "substring" ], "default": "exact" }, "data": { "type": "object", "nullable": true, "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listProductsRequestExample_filter": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "iEquals", "value": "USD" } ] } } }, "listProductsRequestExample_resultFields": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": null, "resultFields": [ "version", "label", "attribute1" ] } }, "listProductsRequestExample_valueFields": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": null, "valueFields": [ "version", "label", "attribute1" ] } } } } } } } }, "/update/C": { "post": { "summary": "Update a Customer", "operationId": "post-update-C", "responses": { "200": { "$ref": "#/components/responses/customerResponse" } }, "tags": [ "Customers" ], "description": "Updates an existing customer.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateCustomerRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "typedId": { "type": "string", "minLength": 1 } }, "required": [ "attribute1", "attribute2", "typedId" ] }, "oldValues": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "parentId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "nodeId": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "isParent": { "type": "boolean" } }, "required": [ "version", "typedId", "customerId", "name", "nodeId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2", "isParent" ] }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data", "oldValues", "operationType", "textMatchStyle" ] }, "examples": { "updateCustomerRequest": { "value": { "data": { "attribute1": "Derry Lane 11", "attribute2": "+44123456789", "typedId": "2147492216.C" }, "oldValues": { "version": 0, "typedId": "2147492216.C", "customerId": "00003", "name": "Kate Smith", "parentId": null, "userGroupEdit": null, "userGroupViewDetails": null, "nodeId": 2147492216, "createDate": "2021-09-22T12:56:16", "createdBy": 2147490696, "lastUpdateDate": "2021-09-22T12:56:16", "lastUpdateBy": 2147490696, "attribute1": "Derry Lane", "attribute2": "123456789", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "isParent": false }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "" } } }, "/integrate/PX": { "post": { "summary": "Upsert a Product Extension", "operationId": "post-integrate-PX", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Creates or updates a product extension.

\nTo *add* a new product extension that does not exist, specify the `sku` and `name` (category) parameter in the request.

\nTo *update* an existing product extension, specify the `name` and `sku` or `typedId` parameters of the *existing* product extension. The **`/integrate`** method performs a partial update – it does not delete values from fields that have not been specified in the update request.

\nUse the **`/integrate/{TypeCode}/returnolddata`** endpoint to return also the data of the previous version in the response.\n\n---\n**Please note**\n\nThis method is intended to be used with one or two objects and it allows you to update particular fields. The request will overwrite the existing data of the record being updated, regardless of other changes.\nTo work with more customers in bulk please use the **`/loaddata/P`** endpoint.\n\n---\n\nThis operation is particularly useful if the caller does not (and should not) know about typed IDs and other *internal* data fields, i.e. typically in an integration scenario.

\nThe only mandatory pre-requisite for this operation is that the object's defined business key fields (vary per object type) are present in every request. No typed ID or version fields are required. This also means that no version checking is performed, thus the request will overwrite existing data of that record, regardless of other changes.\n\n---\n**Information**\n\nYou can upsert multiple records using within request. To do so, add multiple `data` objects into your JSON.\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertProductExtensionRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku", "name" ], "properties": { "sku": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "upsertProductextensionRequest": { "value": { "data": { "sku": "111111", "name": "ProductX", "attribute1": "prdct", "attribute2": "USD" } } } } } } }, "tags": [ "Product Extensions" ] } }, "/uploadmanager.newuploadslot": { "parameters": [], "get": { "summary": "1. Create an Upload Slot", "operationId": "get-uploadmanager.newuploadslot-ownerTypedId", "description": "Returns a slot **ID** that is needed for the **`/bdmanager.upload/{typedId}/{slot_id}`**, or `/productimages.upload/{slot_id}/{sku}` (*Upload a File*) endpoint.\n\n\n>**Information**\n>\n>To upload a file you need to perform the following actions:\n>1. Create an Upload Slot\n>2. Upload a File\n>3. Delete an Upload Slot\n", "responses": { "200": { "description": "Slot created.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "createUploadSlotResponse", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } }, "examples": { "createUploadSlotResponseExample": { "value": { "response": { "node": "node", "csrfToken": "token", "data": [ { "id": "4101" } ], "status": 0 } } } } } } } }, "tags": [ "Product Image", "Attachments" ] }, "post": { "summary": "1. Create an Upload Slot", "operationId": "post-uploadmanager.newuploadslot-ownerTypedId", "responses": { "200": { "description": "Slot created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "id": "1" } ], "status": 0 } } } } } } } }, "description": "Returns a slot ID that is needed for the `/bdmanager.upload/{typedId}/{slot_id}`, or `/productimages.upload/{slot_id}/{sku}` (Upload a File) endpoint. Same behavior and response as GET `/uploadmanager.newuploadslot`.\n\n\n>**Information**\n>\n>To upload a file you need to perform the following actions:\n>1. Create an Upload Slot\n>2. Upload a File\n>3. Delete an Upload Slot", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "ownerTypedId", "description": "Optionally, the request URL can include the `ownerTypedId` parameter if the uploaded file should be attached to a specific owner entity, such as a Quote (Typed ID)." } ], "tags": [ "Attachments", "Product Image" ] } }, "/bdmanager.upload/{typedId}/{slotId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the document you want to attach the file to." }, { "schema": { "type": "string" }, "name": "slotId", "in": "path", "required": true, "description": "The ID of the slot you want to use for the upload. retrieve the slot ID using the `/uploadmanager.newuploadslot` (Create an Upload Slot) endpoint." } ], "post": { "summary": "2. Upload a File", "operationId": "post-bdmanager.upload-typedId-slotId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BinaryData" } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-8dbb5b975-rvc75", "data": [ { "version": 0, "typedId": "1139.BD", "embeddedOwner": null, "fileName": "DataExport-1649934421115.xlsx", "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "length": 55021, "userGroupEdit": null, "userGroupViewDetails": null, "createdByName": "admin", "lastUpdateByName": null, "latestUploadStatusId": 4296, "sentViaEmail": false, "sender": null, "recipients": null, "createDate": "2022-10-05T09:57:05", "createdBy": 2147490696, "lastUpdateDate": "2022-10-05T09:57:06", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Attachments" ], "description": "Uploads a file.\n\nTo upload a file you need to retrieve the slot ID using the `/uploadmanager.newuploadslot` (**Create an Upload Slot**) endpoint.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "A **base64** encoded file data." } } } } } } } }, "/productimages.upload/{slot_id}/{sku}": { "parameters": [ { "schema": { "type": "string", "example": "2665" }, "name": "slot_id", "in": "path", "required": true, "description": "Enter the ID of the slot you want to use for the upload." }, { "schema": { "type": "string" }, "name": "sku", "in": "path", "required": true, "description": "Enter the `sku` of the product you want to add the product image to." } ], "post": { "summary": "2. Upload a File", "operationId": "post-productimages.upload-slot_id-sku", "responses": { "200": { "description": "OK" } }, "tags": [ "Product Image" ], "description": "Uploads a file and adds it to the specified product.

\nTo upload a file you need to retrieve the slot ID using the **`/uploadmanager.newuploadslot`** (*Create an Upload Slot*) endpoint.\n\n\n>**Information**\n>\n>To upload a file you need to perform the following actions:\n>1. Create an Upload Slot\n>2. Upload a File\n>3. Delete an Upload Slot", "parameters": [], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "A **base64** encoded file data." } } }, "examples": {} } }, "description": "" } } }, "/uploadmanager.deleteslot/{slot_id}": { "get": { "summary": "3. Delete an Upload Slot", "tags": [ "Product Image", "Attachments" ], "responses": { "200": { "description": "Slot deleted.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteUploadSlotResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "contentLength", "totalBytesRead", "status", "percentage", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "contentLength": { "type": "number" }, "totalBytesRead": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "data": {}, "owner": {}, "percentage": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "deleteUploadSlotResponseExample": { "value": { "response": { "node": "string", "csrfToken": "string", "data": [ { "version": 0, "typedId": "string", "contentLength": 0, "totalBytesRead": 0, "status": "string", "data": null, "owner": null, "percentage": 0, "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "status": 0 } } } } } } } }, "operationId": "get-Delete-an-Upload-Slot", "description": "Deletes the upload slot that has been created using the **`/uploadmanager.newuploadslot`** (Create an Upload Slot) method and retrieves the file upload status, file version and other details.\n\n\n>**Information**\n>\n>To upload a file you need to perform the following actions:\n>1. Create an Upload Slot\n>2. Upload a File\n>3. Delete an Upload Slot" }, "parameters": [ { "schema": { "type": "string", "example": "2665" }, "name": "slot_id", "in": "path", "required": true, "description": "Enter the ID of the slot you want to delete." } ], "post": { "summary": "3. Delete an Upload Slot", "operationId": "post-Delete-an-Upload-Slot", "responses": { "200": { "description": "Slot deleted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "contentLength": { "type": "integer" }, "totalBytesRead": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "percentage": { "type": "integer" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "4.US", "contentLength": 0, "totalBytesRead": 0, "status": "DONE", "data": null, "owner": null, "percentage": 0, "createDate": "2026-02-16T09:58:10", "createdBy": 2, "lastUpdateDate": "2026-02-16T09:58:10", "lastUpdateBy": 2 } ], "status": 0 } } } } } } } }, "description": "Deletes an upload slot and returns upload status information. Same behavior and response shape as GET `/uploadmanager.deleteslot/{slot_id}`.\n\n\n>**Information**\n>\n>To upload a file you need to perform the following actions:\n>1. Create an Upload Slot\n>2. Upload a File\n>3. Delete an Upload Slot", "tags": [ "Attachments", "Product Image" ] } }, "/delete/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "example": "P", "enum": [ "ACTT", "AP", "APIK", "BD", "BPT", "BR", "C", "CA", "CAM", "CDESC", "CF", "CFS", "CFT", "CH", "CLLI", "CN", "CS", "CT", "CTAM", "CTLI", "CTMU", "CTMUI", "CTT", "CTTAM", "CTTREE", "CW", "CX", "CXAM", "DA", "DB", "DCR", "DCRAM", "DCRI", "DCRL", "DCRMC", "DCRT", "DE", "DI", "DM", "DMDC", "DMDL", "DMDS", "DMF", "DMM", "DMR", "DMT", "DREG", "DWT", "ET", "EVT", "F", "FE", "FN", "IDC", "IE", "ISH", "JST", "JLTV", "JLTVM", "LAT", "LT", "LTT", "LTV", "M", "MLTV", "MLTV2", "MLTV3", "MLTV4", "MLTV5", "MLTV6", "MLTVM", "MPL", "MPLAM", "MPLI", "MPLIT", "MPLT", "MR", "MRAM", "MT", "P", "PAM", "PAPIJ", "PBOME", "PCOMP", "PCW", "PDESC", "PG", "PGI", "PGIM", "PGT", "PH", "PL", "PLI", "PLIM", "PLT", "PR", "PRAM", "PREF", "PT", "PWH", "PX", "PXAM", "PXREF", "PYR", "PYRAM", "Q", "QAM", "QLI", "QMU", "QMUI", "QT", "QTT", "QTTAM", "R", "RAT", "RATM", "RBA", "RBAAM", "RBALI", "RBAT", "RBT", "RBTAM", "RR", "RRAM", "RRS", "RRSC", "RT", "SAT", "SC", "SCN", "SCNAM", "SCT", "SIAM", "SIM", "SIMI", "TFA", "TODO", "U", "UG", "US", "W", "WD", "WF", "WFE", "XPGI", "XPLI", "XSIMI" ] }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to delete the object from. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article." } ], "post": { "summary": "Delete an Object", "tags": [ "General" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteObjectResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "sku", "label", "unitOfMeasure", "userGroupEdit", "userGroupViewDetails", "currency", "formulaName", "image", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "image": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "operationId": "post-delete-TypeCode", "description": "Deletes an object.

Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

**Note**: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteObjectRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteObjectRequestExample": { "value": { "data": { "typedId": "2147501187.P" } } } } } } } } }, "/delete/P": { "post": { "summary": "Delete a Product", "tags": [ "Products" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteProductResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "sku", "label", "unitOfMeasure", "userGroupEdit", "userGroupViewDetails", "currency", "formulaName", "image", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "formulaName": { "type": "string", "minLength": 1 }, "image": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "operationId": "post-delete-P", "description": "Deletes a product.

\n\n>**Please note**:\n>Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

\n\nSome object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.\n\n>You can upsert multiple records using one request. To do so, add multiple data objects into your JSON. See the example below.\n\n```json\n[\n {\n \"data\": {\n \"typedId\": \"2147501223.P\"\n }\n },\n {\n \"data\": {\n \"typedId\": \"2147501224.P\"\n }\n },\n {\n \"data\": {\n \"typedId\": \"2147501225.P\"\n }\n }\n]\n```", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteProductRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "deleteProductRequestExample": { "value": { "data": { "typedId": "2147501187.P" } } } } } } } } }, "/delete/PX": { "post": { "summary": "Delete a Product Extension", "tags": [ "Product Extensions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteProductExtensionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "sku", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {} } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "deleteProductextensionResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 1, "typedId": "9051.PX6", "name": "ProductX", "sku": "111111", "createDate": "2021-09-23T14:44:53", "createdBy": 2147490696, "lastUpdateDate": "2021-09-23T14:44:53", "lastUpdateBy": 2147490696, "attribute1": "prdct", "attribute2": "USD", "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null } ], "status": 0 } } } } } } } }, "operationId": "post-delete-PX", "description": "Deletes a product extension.

Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

**Note**: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteProductExtensionRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteProductExtensionRequestExample": { "value": { "data": { "typedId": "9051.PX6" } } } } } } } }, "parameters": [] }, "/delete/CX": { "post": { "summary": "Delete a Customer Extension", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteCustomerExtensionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "customerId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {} } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "deleteCustomerextensionResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 0, "typedId": "2911.CX3", "name": "Customer001", "customerId": "002", "createDate": "2021-09-20T12:11:05", "createdBy": 2147490696, "lastUpdateDate": "2021-09-20T12:11:05", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null } ], "status": 0 } } } } } } } }, "operationId": "post-delete-CX", "description": "Deletes a customer extension.

Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

**Note**: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteCustomerExtensionRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteCustomerExtensionRequestExample": { "value": { "data": { "typedId": "9051.CX3" } } } } } } }, "tags": [ "Customer Extensions" ] }, "parameters": [] }, "/delete/C": { "post": { "summary": "Delete a Customer", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteCustomerResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "customerId", "name", "nodeId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2", "isParent" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "customerId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "parentId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "nodeId": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "isParent": { "type": "boolean" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "operationId": "post-delete-C", "description": "Deletes a customer.

Only one object can be deleted per request (unless batched). Some object types may be blocked from being deleted by the update command as special processing is done by a dedicated manager command.

**Note**: Some object types are only soft-deleted, some are hard-deleted in the database. This behavior cannot be influenced by the client.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteCustomerRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteCustomerRequestExample": { "value": { "data": { "typedId": "2147492214.C" } } } } } } }, "tags": [ "Customers" ] } }, "/lookuptablemanager.integrate/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "Upsert a Lookup Table Value", "operationId": "post-lookuptablemanager.integrate-tableId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "upsertLookupTableValueResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "value", "lastUpdateByName", "createdByName", "tableId", "type", "valueType", "rawValue", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "lowerBound": {}, "upperBound": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "rawValue": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "upsertPriceParameterResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 2, "typedId": "2147489944.LTV", "name": "tofu", "value": "5", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147484027, "type": "SIMPLE", "valueType": "STRING", "rawValue": "5", "createDate": "2021-10-01T12:27:48", "createdBy": 2147490696, "lastUpdateDate": "2021-10-01T12:27:48", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Creates a new Company Parameter record (LookupTableValue or MatrixLookupTableValue) or updates an existing record (if the specified name of the record already exists).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLEVALUES_INTEGRATE | Data Integration (`DATAINTEGRATION`)", "tags": [ "Lookup Tables / Company Parameters" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertLookupTableValueRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "name", "value" ] } }, "required": [ "data" ] }, "examples": { "upsertPriceParameterRequestExample": { "value": { "data": { "name": "tofu", "value": "0.05" } } } } } } } } }, "/lookuptablemanager.update/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "Update a Lookup Table Value", "operationId": "post-lookuptablemanager.update-tableId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "updateLookupTableValueResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "lastUpdateByName", "createdByName", "tableId", "type", "valueType", "lookupTableTypedId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "name" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "lookupTableTypedId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "name": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "updatePriceParameterRequestExample": { "value": { "response": { "node": "", "data": [ { "version": 12, "typedId": "2147497641.MLTV", "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147484036, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "2147484036.LT", "createDate": "2021-10-06T10:53:52", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T14:37:00", "lastUpdateBy": 2147490696, "attribute1": "250", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "matrixValue" } ], "status": 0 } } } } } } } }, "tags": [ "Lookup Tables / Company Parameters" ], "description": "Updates LookupTableValue. Returns a list of updated LookupTableValue/MatrixLookupTableValue objects.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_UPDATE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateLookupTableValueRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId", "attribute1" ], "properties": { "typedId": { "type": "string", "minLength": 1 }, "attribute1": { "type": "string", "minLength": 1 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId", "lastUpdateByName", "createdByName", "type", "valueType", "lookupTableTypedId", "name" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "lookupTableTypedId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "name": { "type": "string", "minLength": 1 } } }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data", "oldValues", "operationType", "textMatchStyle" ] }, "examples": { "updatePriceParameterRequestExample": { "value": { "data": { "typedId": "2147497641.MLTV", "attribute1": "250" }, "oldValues": { "version": 10, "typedId": "2147497641.MLTV", "lastUpdateByName": "admin", "createdByName": "admin", "tableId": null, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "2147484036.LT", "createDate": "2021-10-06T10:53:52", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T13:20:24", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "matrixValue" }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/lookuptablemanager.delete/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "Delete a Lookup Table Value", "operationId": "post-lookuptablemanager.delete-tableId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteLookupTableValueResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "lastUpdateByName", "createdByName", "tableId", "type", "valueType", "lookupTableTypedId", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "name" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": { "type": "number" }, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "lookupTableTypedId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "string", "minLength": 1 }, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "name": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "deletePriceParameterResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 12, "typedId": "2147497641.MLTV", "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147484036, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "2147484036.LT", "createDate": "2021-10-06T10:53:52", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T14:37:00", "lastUpdateBy": 2147490696, "attribute1": "250", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "matrixValue" } ], "status": 0 } } } } } } } }, "description": "Deletes a record (LookupTableValue or MatrixLookupTableValue) from the specified Company Parameters table (LookupTable).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_REMOVE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteLookupTableValueRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deletePriceParameterRequestExample": { "value": { "data": { "typedId": "2147497641.MLTV" } } } } } }, "description": "" }, "tags": [ "Lookup Tables / Company Parameters" ] } }, "/lookuptablemanager.delete/{tableId}/batch": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "Mass Delete Lookup Table Values", "operationId": "post-lookuptablemanager.delete-tableId-batch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteLookupTableValueResponse", "properties": { "response": { "type": "object", "required": [ "node", "data", "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "The number of deleted records.", "items": {} }, "status": { "type": "number" } } } }, "required": [ "response" ] }, "examples": { "deletePriceParameterResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 12, "typedId": "2147497641.MLTV", "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147484036, "type": "MATRIX", "valueType": "MATRIX", "lookupTableTypedId": "2147484036.LT", "createDate": "2021-10-06T10:53:52", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T14:37:00", "lastUpdateBy": 2147490696, "attribute1": "250", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "name": "matrixValue" } ], "status": 0 } } } } } } } }, "description": "Deletes records from the specified Company Parameters table (LookupTable). A filter can be applied (see the request example).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_REMOVE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "integer" } } } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "upperBound", "operator": "equals", "value": 30 } ] } } } } } } }, "description": "" }, "tags": [ "Lookup Tables / Company Parameters" ], "parameters": [ { "$ref": "#/components/parameters/dataLocale" } ] } }, "/lookuptablemanager.add/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "Add a Lookup Table Value", "operationId": "post-lookuptablemanager.add-tableId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addLookupTableValueResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "value", "lastUpdateByName", "createdByName", "tableId", "valueType", "type", "rawValue", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "lowerBound": {}, "upperBound": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": { "type": "number" }, "valueType": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "rawValue": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "addPriceParameterRecordResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 1, "typedId": "2147490006.LTV", "name": "recordName2", "value": "recordValue2", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": 2147484027, "valueType": "STRING", "type": "SIMPLE", "rawValue": "recordValue2", "createDate": "2021-10-07T09:07:24", "createdBy": 2147490696, "lastUpdateDate": "2021-10-07T09:07:24", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Creates a new LookupTableValue or MatrixLookupTableValue record in the LookupTable (Company Parameter table).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_ADD | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "tags": [ "Lookup Tables / Company Parameters" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addLookupTableValueRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } }, "operation": { "type": "string", "minLength": 1, "description": "Must be 'add' or null or omitted." } }, "required": [ "data" ] }, "examples": { "addPriceParameterRequestExample": { "value": { "data": { "name": "recordName", "value": "recordValue" }, "operation": "add" } } } } } } } }, "/lookuptablemanager.fetch/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." } ], "post": { "summary": "List All Lookup Table Values", "tags": [ "Lookup Tables / Company Parameters" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listAllLookupTableValuesResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "name", "value", "lastUpdateByName", "createdByName", "valueType", "type", "rawValue", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "lowerBound": {}, "upperBound": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "tableId": {}, "valueType": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "rawValue": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." } } } } }, "examples": { "listAllPriceParametersRecordsResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "", "csrfToken": "", "data": [ { "version": 18, "typedId": "2147489943.LTV", "name": "test", "value": "null", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": null, "valueType": "STRING", "type": "SIMPLE", "rawValue": "null", "createDate": "2021-10-01T12:08:23", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T12:49:48", "lastUpdateBy": 2147490696 }, { "version": 2, "typedId": "2147490005.LTV", "name": "recordName", "value": "recordValue", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": null, "valueType": "STRING", "type": "SIMPLE", "rawValue": "recordValue", "createDate": "2021-10-07T09:04:47", "createdBy": 2147490696, "lastUpdateDate": "2021-10-07T09:04:47", "lastUpdateBy": 2147490696 }, { "version": 2, "typedId": "2147490006.LTV", "name": "recordName2", "value": "recordValue2", "lowerBound": null, "upperBound": null, "lastUpdateByName": "admin", "createdByName": "admin", "tableId": null, "valueType": "STRING", "type": "SIMPLE", "rawValue": "recordValue2", "createDate": "2021-10-07T09:07:24", "createdBy": 2147490696, "lastUpdateDate": "2021-10-07T09:07:24", "lastUpdateBy": 2147490696 } ], "endRow": 3 } } } } } } } }, "operationId": "post-lookuptablemanager.fetch-tableId", "description": "Retrieves all Company Parameter records for the specified Company Parameter table (LookupTable).

\nExport the table to the Excel file (XLSX) using the `output=xls` URL query parameter. When exporting to the file, specify fields (within the `resultFields` property) you want to include in the output table.

\nExample:\n```json\n{\n \"data\":{\n \"criteria\":[\n\n ],\n \"operator\":\"and\"\n },\n \"resultFields\":[\n \"key1\",\n \"key2\",\n \"key3\",\n \"attribute1\",\n \"attribute2\",\n \"attribute3\"\n ],\n \"valueFields\":[\n\n ]\n}\n```", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listAllLookupTableValuesRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "sortBy": { "type": "array", "items": { "type": "object" } } } }, "examples": { "getAllPriceParameterRecordsRequestExample": { "value": { "endRow": 30, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } }, "description": "You can specify the start and end row to limit the number of retrieved records." }, "parameters": [ { "$ref": "#/components/parameters/output" }, { "$ref": "#/components/parameters/useColumnNames" } ] } }, "/lookuptablemanager.fetch": { "post": { "summary": "List All Lookup Tables", "tags": [ "Lookup Tables / Company Parameters" ], "responses": { "200": { "x-summary": "OK", "description": "Returns the Company Parameter table / Lookup table fields. The `name` property is the same as `uniqueName` if the `owner` is `null`. If the `owner` field is non-null, then the `name` will be the name of the table (DMT or LT) in the context of the owner.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listAllLookupTablesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" }, "name": { "type": "string" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "listAllParametersResponseExample": { "value": { "response": { "node": "", "csrfToken": "", "startRow": 0, "data": [ { "version": 2, "typedId": "2147484027.LT", "uniqueName": "test", "label": "Test2", "validAfter": "2021-09-29", "status": "ACTIVE", "simulationSet": null, "type": "SIMPLE", "valueType": "STRING", "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "hideWarnings": false, "formatType": null, "lastUpdateByName": "admin", "createdByName": "admin", "numberOfKeyFields": 1, "createDate": "2021-09-30T14:43:25", "createdBy": 2147490696, "lastUpdateDate": "2021-10-01T12:05:34", "lastUpdateBy": 2147490696, "id": 2147484027, "isPlasma": false, "name": "test" }, { "version": 0, "typedId": "2147484036.LT", "uniqueName": "matrix", "label": "matrix", "validAfter": "2021-10-05", "status": "ACTIVE", "simulationSet": null, "type": "MATRIX", "valueType": "MATRIX", "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "hideWarnings": false, "formatType": null, "lastUpdateByName": "admin", "createdByName": "admin", "numberOfKeyFields": 1, "createDate": "2021-10-06T10:53:26", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T10:53:26", "lastUpdateBy": 2147490696, "id": 2147484036, "isPlasma": false, "name": "matrix" } ], "endRow": 2, "totalRows": 2, "status": 0 } } } } } } } }, "operationId": "post-lookuptablemanager.fetch", "description": "Retrieves all Lookup Tables / Company Parameter tables.

\nYou can use this endpoint to retrieve the table ID. The `tableId` can be used in other endpoint URLs that work with Company Parameter Values. Find the table ID in the response under `id` parameter (e.g. `\"id\": 2147484027`).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listAllLookupTablesRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } }, "sortBy": { "type": "array", "items": {} } } }, "examples": { "listAllParametersRequestExample": { "value": { "endRow": 30, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "label", "operator": "iEquals", "value": "matrix" } ] }, "sortBy": [ "uniqueName" ] } } } }, "application/xml": { "schema": { "type": "object", "properties": {} } } }, "description": "You can specify the start and end row to limit the number of retrieved Lookup Tables / Company Parameters." } } }, "/lookuptablemanager.add": { "post": { "summary": "Add a Lookup Table", "operationId": "post-lookuptablemanager.add", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addLookupTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "uniqueName", "label", "validAfter", "status", "type", "valueType", "userGroupEdit", "hideWarnings", "lastUpdateByName", "createdByName", "numberOfKeyFields", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "id", "isPlasma" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": { "type": "string", "minLength": 1 }, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Lookup Tables / Company Parameters" ], "description": "Creates a new LookupTable.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_ADD | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addLookupTableRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "uniqueName", "validAfter", "type", "valueType", "status" ], "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "formatType": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1 } } }, "operation": { "type": "string", "minLength": 1 } }, "required": [ "data" ] }, "examples": { "addPriceParameterRequestExample": { "value": { "data": { "uniqueName": "pp01", "label": "Price Parameter 001", "validAfter": "2021-10-06", "type": "MATRIX", "valueType": "MATRIX", "status": "ACTIVE", "formatType": "MONEY_USD", "userGroupEdit": "Administrators" }, "operation": "add" } } } } }, "description": "The request must contain all fields that are part of the business key for that object and all non-nullable fields." } } }, "/lookuptablemanager.delete": { "post": { "summary": "Delete a Lookup Table", "operationId": "post-lookuptablemanager.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteLookupTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "uniqueName", "label", "validAfter", "status", "type", "valueType", "hideWarnings", "lastUpdateByName", "createdByName", "numberOfKeyFields", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "id", "isPlasma" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] }, "examples": { "deleteLookupTableResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 0, "typedId": "2147484036.LT", "uniqueName": "matrix", "label": "matrix", "validAfter": "2021-10-05", "status": "ACTIVE", "simulationSet": null, "type": "MATRIX", "valueType": "MATRIX", "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "hideWarnings": false, "formatType": null, "lastUpdateByName": "admin", "createdByName": "admin", "numberOfKeyFields": 1, "createDate": "2021-10-06T10:53:26", "createdBy": 2147490696, "lastUpdateDate": "2021-10-06T10:53:26", "lastUpdateBy": 2147490696, "id": 2147484036, "isPlasma": false } ], "status": 0 } } } } } } } }, "description": "Deletes a Lookup Table specified by `typedId`.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_REMOVE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteLookupTableRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteLookupTableRequestExample": { "value": { "data": { "typedId": "2147484036.LT" } } } } } }, "description": "Specify the `typedId` of the Lookup Table (Company Parameters) you want to delete." }, "tags": [ "Lookup Tables / Company Parameters" ] } }, "/lookuptablemanager.resetcolumn/{tableId}/{columnName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table. The ID can be retrieved using the `/lookuptablemanager.fetch` method." }, { "schema": { "type": "string" }, "name": "columnName", "in": "path", "required": true, "description": "Enter the name of the column you want to delete values from." } ], "post": { "summary": "Delete Column Values (Matrix only)", "operationId": "post-lookuptablemanager.resetcolumn-tableId-columnName", "responses": { "200": { "description": "OK" } }, "description": "Resets column data of a given lookup table. Currently MatrixLookupTable tables.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_REMOVE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "tags": [ "Lookup Tables / Company Parameters" ] } }, "/lookuptablemanager.loaddata/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "JLTV", "JLTVM", "LT", "LTT", "LTV", "MLTV", "MLTV2", "MLTV3", "MLTV4", "MLTV5", "MLTV6", "MLTVM" ], "example": "MLTV" }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the Lookup Table entity you want to insert a data to." } ], "post": { "summary": "Insert Bulk Data to Lookup Table", "operationId": "post-lookuptablemanager.loaddata-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "insertBulkDataLookupTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "properties": {} } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Lookup Tables / Company Parameters" ], "description": "Inserts multiple records to the specified Lookup Table.\n\nThe `/loaddata` operation is a very efficient and quick way to insert bulk data. The main advantage is its greater speed when loading thousands of records (compared to e.g. `/integrate`).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "insertBulkDataToLookupTableRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "header", "data" ], "properties": { "header": { "type": "array", "description": "Specify fields (columns) where you want to insert the data to.", "items": {} }, "data": { "type": "array", "description": "Enter values you want to add to the fields (columns).", "items": {} } } } }, "required": [ "data" ] }, "examples": { "insertBulkDataMLTVRequestExample": { "value": { "data": { "header": [ "attribute1", "lookupTable" ], "data": [ [ "att1-1", "2147484051" ], [ "att1-2", "2147484051" ], [ "att1-3", "2147484051" ] ] } } } } } }, "description": "We used `/lookuptablemanager.loaddata/MLTV` in the request example to insert bulk data to Matrix Lookup Table. Notice that the `lookupTable` is used in the `header` section and then ID of the Lookup Table in the `data` section" } } }, "/lookuptablemanager.copy/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table you want to copy." } ], "post": { "summary": "Copy a Lookup Table", "tags": [ "Lookup Tables / Company Parameters" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "copyLookupTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "uniqueName", "validAfter", "status", "type", "valueType", "hideWarnings", "lastUpdateByName", "createdByName", "numberOfKeyFields", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "id", "isPlasma" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" } } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] } } } } }, "operationId": "post-lookuptablemanager.copy-tableId", "description": "Creates a copy of the specified Lookup Table, including LookupTableValue/MatrixLookupTableValue values and preferences.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_COPY | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)" } }, "/lookuptablemanager.update": { "post": { "summary": "Update a Lookup Table", "operationId": "post-lookuptablemanager.update", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "updateLookupTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "uniqueName", "label", "validAfter", "status", "type", "valueType", "hideWarnings", "lastUpdateByName", "createdByName", "numberOfKeyFields", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "id", "isPlasma" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Lookup Tables / Company Parameters" ], "description": "Updates a Lookup Table.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_UPDATE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateLookupTableRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "description": "Enter values you want to update in the \"field name = value\" fashion. Multiple field values in one request can be updated.", "properties": { "label": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "typedId": { "type": "string", "minLength": 1 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId", "uniqueName", "validAfter", "type", "valueType" ], "description": "Specify values of the object before the update. Especially important are typedId (to identify the object to update) and version (to detect date inconsistencies).", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "type": { "type": "string", "minLength": 1 }, "valueType": { "type": "string", "minLength": 1 }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "hideWarnings": { "type": "boolean" }, "formatType": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "numberOfKeyFields": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "id": { "type": "number" }, "isPlasma": { "type": "boolean" } } }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data", "oldValues" ] }, "examples": { "updateLookupTableRequestExample": { "value": { "data": { "label": "The New Label", "status": "ACTIVE", "typedId": "2147484051.LT" }, "oldValues": { "version": 0, "typedId": "2147484051.LT", "uniqueName": "pp02", "label": null, "validAfter": "2021-10-20", "status": "INACTIVE", "simulationSet": null, "type": "MATRIX", "valueType": "MATRIX", "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "hideWarnings": false, "formatType": null, "lastUpdateByName": "admin", "createdByName": "admin", "numberOfKeyFields": 1, "createDate": "2021-10-20T11:44:07", "createdBy": 2147490696, "lastUpdateDate": "2021-10-20T11:44:07", "lastUpdateBy": 2147490696, "id": 2147484051, "isPlasma": false }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "" } } }, "/lookuptablemanager.findref/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "Enter the ID of the table you want to retrieve logic references for." } ], "post": { "summary": "Get Logic References", "tags": [ "Lookup Tables / Company Parameters" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getLogicReferencesResponse", "properties": { "response": { "type": "object", "required": [ "node", "csrfToken", "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "number" } } } }, "required": [ "response" ] } } } } }, "operationId": "post-lookuptablemanager.findref-tableId", "description": "Retrieves a list of logics for a given Lookup Table.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_UPDATE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)" } }, "/lookuptablemanager.massedit/{tableId}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableId", "in": "path", "required": true, "description": "The ID of the Lookup Table whose values you want to update." } ], "post": { "summary": "Mass Edit", "operationId": "post-lookuptablemanager.massedit-tableId", "responses": { "200": { "description": "OK - The response contains the number of modifed objects.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "massEditResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "A single item array with a string that represents the number of rows changed.", "items": { "type": "string" } }, "status": { "type": "number", "description": "A status code." } } } } }, "examples": { "masseditResponseExample": { "value": { "response": { "node": "", "data": [ "3" ], "status": 0 } } } } } } } }, "description": "Performs a mass edit action on LookupTableValue or MatrixLookupTableValue objects. Updates LTV or MLTV columns to specified values.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n LOOKUPTABLE_UPDATE | Administer Price Parameters (`PB_PARAMETERS`), Administer Plasma (`PLASMA`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "massEditRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "filterCriteria", "massEditRecords" ], "properties": { "filterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "description": "`TypedId` of rows whose columns you want to update.", "items": { "type": "string" } }, "_constructor": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "_constructor" ] } } } }, "massEditRecords": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "massEditOperator": { "type": "string", "minLength": 1, "description": "Can be either one of these valid operators: `+`, `-`, `*`. If omitted, the provided value is set (`=` operator). Otherwise the specified operation is applied." }, "fieldValue": { "type": "string", "minLength": 1, "description": "The new value of the field (column)." }, "precision": {} }, "required": [ "fieldName", "massEditOperator", "fieldValue" ] } } } } }, "required": [ "data" ] }, "examples": { "massEditRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "2147497753", "2147497754", "2147497755" ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "attribute1", "massEditOperator": "=", "fieldValue": "1", "precision": null }, { "fieldName": "attribute2", "massEditOperator": "=", "fieldValue": "2", "precision": null }, { "fieldName": "attribute3", "massEditOperator": "=", "fieldValue": "3", "precision": null } ] } } } } } } }, "tags": [ "Lookup Tables / Company Parameters" ] } }, "/productmanager.fetchproductsetcompetition/{label}": { "parameters": [ { "schema": { "type": "string" }, "name": "label", "in": "path", "required": true, "description": "Enter the name of the product set you want to retrieve." } ], "post": { "summary": "Get a Product Set", "operationId": "post-productmanager.fetchproductsetcompetition-label", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getProductSetResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "products": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "attributes": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "value": {} }, "required": [ "field" ] } } }, "required": [ "id" ] } }, "options": { "type": "array", "items": { "type": "object" } } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } }, "required": [ "response" ] } } } } }, "description": "Retrieves products from the specified product set (configured for Competition Data API).

\n\n\n>**Information**:\n>You can retrieve the product set's `label` (that is required in the URL of this endpoint as a parameter) using the `/fetch/PCOMPCO` endpoint.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRODUCTCOMPETITION_FETCH | Data Integration (`DATAINTEGRATION`), View Competition Data (`PB_COMPETITION_RO`), Manage Products (`PB_PRODUCTEDITOR`), Administer Products (`PB_PRODUCTS`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage Product Details Only (`PB_PDETAILSEDITOR`), Manage Products & Use EC (`PB_PRODUCTEDITOR_EC`), Manage Competition Data (`PB_COMPETITION`)", "tags": [ "Competition Data", "Products" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "getProductSetRequest", "type": "object", "properties": { "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." } } }, "examples": { "getProductSetRequestExample": { "value": { "startRow": 0, "endRow": 10 } } } } } } } }, "/productmanager.fetchproductcompetition": { "post": { "summary": "Get Competition Data", "tags": [ "Competition Data", "Products" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getCompetitionDataResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "sku", "label", "price", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "competitorSku": {}, "competitor": {}, "label": { "type": "string", "minLength": 1 }, "price": { "type": "number" }, "priceType": {}, "priceUnit": {}, "unitOfMeasure": {}, "currency": {}, "competitionType": {}, "source": {}, "country": {}, "priority": {}, "comments": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "priceAPIRecord": {}, "integrationToken": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "infoDate": {} } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "operationId": "post-productmanager.fetchproductcompetition", "description": "Retrieves products from the Competition Data table.

\n\n---\n**Please note**: Returns the entire Competition Data table. The table can grow very large when no mechanism is put in place to delete stale records, and if you employ multiple data providers, this will return all data, irrespective of the source.

\nAdditionally to the regular **/fetch** command, this command supports (i.e. transparently handles) also global data as configured. This means that if, for example, the product competition data is configured to come from the global partition, this command will retrieve it from there. The regular fetch command will always only return data for the local partition.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRODUCTCOMPETITION_FETCH | Data Integration (`DATAINTEGRATION`), View Competition Data (`PB_COMPETITION_RO`), Manage Products (`PB_PRODUCTEDITOR`), Administer Products (`PB_PRODUCTS`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage Product Details Only (`PB_PDETAILSEDITOR`), Manage Products & Use EC (`PB_PRODUCTEDITOR_EC`), Manage Competition Data (`PB_COMPETITION`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "getCompetitionDataRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 } } }, "examples": { "getProductCompetitionRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } } } } }, "/fetch/PCOMPCO": { "post": { "summary": "List Product Sets", "operationId": "post-fetch-PCOMPCO", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listProductSetsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "filterCriteria": { "type": "string", "minLength": 1 }, "fieldsMapping": { "type": "string", "minLength": 1 }, "structure": { "type": "string", "minLength": 1 }, "options": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Competition Data" ], "description": "Retrieves details of all product sets for Competition Data API.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listProductSetsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 } } }, "examples": { "listProductSetsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } } } } }, "/productmanager.importproductcompetition": { "post": { "summary": "Import Competition Data", "operationId": "post-productmanager.importproductcompetition", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "importCompetitionDataResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "updated": { "type": "integer", "description": "The number of records that have been updated." }, "inserted": { "type": "integer", "description": "The number of newly added records." }, "error": { "type": "integer", "description": "The number of error records." }, "errorRecords": { "type": "array", "description": "The list of errors with its records from the request.", "items": { "type": "object", "properties": { "record": { "type": "object", "description": "The error record from the request.", "properties": { "sku": { "type": "string" }, "label": { "type": "string" }, "price": { "type": "number" }, "currency": { "type": "string" }, "competitor": { "type": "string" }, "competitorSku": { "type": "string" }, "competitionType": { "type": "string" }, "country": { "type": "string" }, "comments": { "type": "string" }, "source": { "type": "string" }, "priceType": { "type": "string" }, "priceUnit": { "type": "number" }, "unitOfMeasure": { "type": "string" }, "infoDate": { "type": "string" }, "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo3": { "type": "string" }, "additionalInfo4": { "type": "string" } } }, "errorMessages": { "type": "array", "items": { "type": "string" } } } } } } }, "status": { "type": "number" } } } }, "required": [ "response" ] } } } } }, "description": "Adds products to the Competition Data table. Returns the number of updated, inserted, and failed records during the import. Creates a new row for each product.", "tags": [ "Competition Data", "Products" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "importCompetitionDataRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "importStrategy", "products" ], "properties": { "importStrategy": { "type": "string", "enum": [ "INSERT", "UPDATE" ], "description": "INSERT - always inserts new records, even duplicates.\nUPDATE - data is always overridden.\n" }, "products": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "price": { "type": "number" }, "currency": { "type": "string", "minLength": 1 }, "competitor": { "type": "string", "minLength": 1 }, "competitorSku": { "type": "string", "minLength": 1 }, "competitionType": { "type": "string", "minLength": 1 }, "country": { "type": "string", "minLength": 1 }, "priceUnit": { "type": "number" }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "infoDate": { "type": "string", "minLength": 1 }, "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo4": { "type": "string", "minLength": 1 } }, "required": [ "sku" ] } } } } }, "required": [ "data" ] }, "examples": { "importCompetitionDataRequestExample": { "value": { "data": { "importStrategy": "INSERT", "products": [ { "sku": "01", "label": "Product01", "price": 10, "currency": "EUR", "competitor": "COMP", "competitorSku": "P001", "competitionType": "string", "country": "Spain", "priceUnit": 1, "unitOfMeasure": "string", "infoDate": "2021-10-25T12:14:28.646Z", "additionalInfo1": 0, "additionalInfo2": 100, "additionalInfo4": "test" }, { "sku": "02", "label": "Product02", "price": 10, "currency": "EUR", "competitor": "COMP", "competitorSku": "P002", "competitionType": "string", "country": "Italy", "priceUnit": 1, "unitOfMeasure": "string", "infoDate": "2021-10-25T12:16:28.646Z", "additionalInfo1": 0, "additionalInfo2": 100, "additionalInfo4": "test" } ] } } } } } }, "description": "The competition product details." } } }, "/workflowsmanager.fetch/active": { "post": { "summary": "List Pending Approvals", "operationId": "post-workflowsmanager.fetch-active", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listPendingApprovalsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "approvableTypedId": { "type": "string", "minLength": 1 }, "approvableUniqueName": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "storesOnlyHeaderOfApprovableState": { "type": "boolean" }, "expandedActiveUsers": { "type": "string" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "delegation": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" } } } } }, "examples": { "listPendingApprovalsResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "", "data": [ { "version": 5, "typedId": "2147484854.W", "uniqueName": "P-2147491330-2147484854", "label": "P-2147491330 (New QuoteWF)", "approvableTypedId": "2147491330.Q", "approvableUniqueName": "P-2147491330", "currentStepId": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef", "workflowStatus": "SUBMITTED", "code": "Q", "storesOnlyHeaderOfApprovableState": false, "expandedActiveUsers": "", "createDate": "2021-10-26T16:07:00", "createdBy": 2147490696, "lastUpdateDate": "2021-10-26T16:07:00", "lastUpdateBy": 2147490696, "delegation": "None" } ], "endRow": 1 } } } } } } } }, "tags": [ "Workflow" ], "description": "Retrieves a list of all authenticated user's approvals.\n\n**Available for the following roles**:\n- `ADMIN_WO_USER_MGMT` (*General Admin (without User Management)*)\n- `SUPPORT` (*Investigate for Support*)\n- `PRICESHOP_RO` (*View Quoting*)\n- `PRICESHOP_EDIT` (*Edit Quoting*)\n- `PB_PRICEGRIDS_RO` (*View LPG*)\n- `WF_BUILDER` (*Manage Workflow Logics*)\n- `RM_RAT` (*Manage Rebate Templates*)\n- `RM_REBATEAGREEMENTS_RO` (*View Rebate Agreements*)\n- `RM_REBATEAGREEMENTS` (*Manage Rebate Agreements*)\n- `WF_BUILDER` (*Manage Workflow Logics*)\n- `CONTRACTS_RO` (*View A&P*)\n- `CM_CONTRACTMANAGER` (*Manage A&P module*)\n- `CONTRACTS_RO` (*View A&P*)\n- `WF_ADMIN` (*Manage Workflows*)\n- `SC_COMPENSATIONS_RO` (*View Compensation Plans*)\n- `SC_ADMIN` (*Administer Sales Compensations module*)" } }, "/workflowsmanager.fetchfilteredbyapprovable/active/{loginName}": { "post": { "summary": "List User's Pending Approvals", "operationId": "post-workflowsmanager.fetchfilteredbyapprovable-active-loginName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listUserPendingApprovalsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "approvableTypedId": { "type": "string", "minLength": 1 }, "approvableUniqueName": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "storesOnlyHeaderOfApprovableState": { "type": "boolean" }, "expandedActiveUsers": { "type": "string" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "delegation": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" } } } } }, "examples": { "listPendingApprovalsResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "", "data": [ { "version": 5, "typedId": "2147484854.W", "uniqueName": "P-2147491330-2147484854", "label": "P-2147491330 (New QuoteWF)", "approvableTypedId": "2147491330.Q", "approvableUniqueName": "P-2147491330", "currentStepId": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef", "workflowStatus": "SUBMITTED", "code": "Q", "storesOnlyHeaderOfApprovableState": false, "expandedActiveUsers": "John Price", "createDate": "2021-10-26T16:07:00", "createdBy": 2147490696, "lastUpdateDate": "2021-10-26T16:07:00", "lastUpdateBy": 2147490696, "delegation": "None" } ], "endRow": 1 } } } } } } } }, "tags": [ "Workflow" ], "description": "Retrieves a list of Pending Approvals for the particular user." }, "parameters": [ { "schema": { "type": "string", "example": "john.price" }, "name": "loginName", "in": "path", "required": true, "description": "The login name of the user you want to retrieve Pending Workflows for." } ] }, "/workflowsmanager.fetch": { "post": { "summary": "List Workflows", "operationId": "post-workflowsmanager.fetch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listWorkflowsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "approvableTypedId": { "type": "string", "minLength": 1 }, "approvableUniqueName": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 }, "storesOnlyHeaderOfApprovableState": { "type": "boolean" }, "expandedActiveUsers": { "type": "string" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "delegation": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" } } } } }, "examples": { "listPendingApprovalsResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "", "csrfToken": "", "data": [ { "version": 4, "typedId": "2147484854.W", "uniqueName": "P-2147491330-2147484854", "label": "P-2147491330 (New QuoteWF)", "approvableTypedId": "2147491330.Q", "approvableUniqueName": "P-2147491330", "currentStepId": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef", "workflowStatus": "SUBMITTED", "code": "Q", "storesOnlyHeaderOfApprovableState": false, "expandedActiveUsers": "", "createDate": "2021-10-26T16:07:00", "createdBy": 2147490696, "lastUpdateDate": "2021-10-26T16:07:00", "lastUpdateBy": 2147490696, "delegation": "None" } ], "endRow": 1 } } } } } } } }, "tags": [ "Workflow" ], "description": "Retrieves a list of workflows (based on filter settings) where the authenticated user participates. The request can be sent also with an empty body (without filters or paging) in order to retrieve all workflows.\nReturns all workflows if the authenticated user is the workflow admin.\n\n---\n**Filter example**:

\nReturns only workflows where *document type* = **Quote** and *workflow status* = **Approved**.\n```json\n{\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"code\",\n \"operator\":\"equals\",\n \"value\":\"Q\"\n },\n {\n \"fieldName\":\"workflowStatus\",\n \"operator\":\"equals\",\n \"value\":\"APPROVED\"\n }\n ]\n }\n}\n```\n\n**Available for the following roles**:\n- `ADMIN_WO_USER_MGMT` (*General Admin (without User Management)*)\n- `SUPPORT` (*Investigate for Support*)\n- `PRICESHOP_RO` (*View Quoting*)\n- `PRICESHOP_EDIT` (*Edit Quoting*)\n- `PB_PRICEGRIDS_RO` (*View LPG*)\n- `WF_BUILDER` (*Manage Workflow Logics*)\n- `RM_RAT` (*Manage Rebate Templates*)\n- `RM_REBATEAGREEMENTS_RO` (*View Rebate Agreements*)\n- `RM_REBATEAGREEMENTS` (*Manage Rebate Agreements*)\n- `WF_BUILDER` (*Manage Workflow Logics*)\n- `CONTRACTS_RO` (*View A&P*)\n- `CM_CONTRACTMANAGER` (*Manage A&P module*)\n- `CONTRACTS_RO` (*View A&P*)\n- `WF_ADMIN` (*Manage Workflows*)\n- `SC_COMPENSATIONS_RO` (*View Compensation Plans*)\n- `SC_ADMIN` (*Administer Sales Compensations module*)\n", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listWorkflowsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "and", "or" ] }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "enum": [ "uniqueName", "label", "code", "workflowStatus", "delegation", "notificationSent", "createDate" ], "description": "Specify the name of the field you want to filter the returned workflows by." }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1, "enum": [ "CL", "CT", "DCR", "DP", "MR", "PL", "PGI", "XPGI", "Q", "RBA", "RR", "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ], "description": "Specify the workflow status or the type code." } } } } } } } }, "examples": { "listWorkflowsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "workflowStatus", "operator": "equals", "value": "SUBMITTED" } ] } } } } } } } }, "parameters": [] }, "/workflowsmanager.fetchdetailsviaapprovable/{typedId}": { "post": { "summary": "Get a Workflow Document", "operationId": "post-workflowsmanager.fetchdetailsviaapprovable-typedId", "tags": [ "Workflow" ], "description": "Retrieves workflow details of the approvable object.
\n\nSee the [Workflows](https://pricefx.atlassian.net/wiki/display/UNITY/Workflows) article to find out which documents types can have approval workflows.\n\n**Available for the following roles**:\n- `ADMIN_WO_USER_MGMT` (*General Admin (without User Management)*)\n- `SUPPORT` (*Investigate for Support*)\n- `PRICESHOP_RO` (*View Quoting*)\n- `PB_PRICELISTS_RO` (*View Price Lists*)\n- `PB_PRICEGRIDS_RO` (*View LPG*)\n- `RM_REBATEAGREEMENTS_RO` (*View Rebate Agreements*)\n- `RM_REBATEAGREEMENTS` (*Manage Rebate Agreements*)\n- `RM_REBATERECORDS` (*Manage Rebate Records*)\n- `RM_REBATERECORDS_RO` (*View Rebate Records*)\n- `CONTRACTS_RO` (*View A&P*)\n- `CM_CONTRACTS` (*Manage A&P*)\n- `CLM_CLAIM` (*Use Claims*)\n- `WF_ADMIN` (*Manage Workflows*)\n- `PO_MODELRECORDS_RO` (*View Policy Records*)\n- `PO_MODELRECORDS_APPROVAL` (*Approve Policy Records*)\n- `MODULECATEGORY_MO_RO` (*View Model in Module Category*)\n- `SC_COMPENSATIONS_RO` (*View Compensation Plans*)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getWorkflowDocumentResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": {} }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": {} }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": {} }, "userLoginNames": { "type": "array", "items": {} }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": {} }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": {} }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": {} }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": {} }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": {} }, "comment": {}, "mandatoryComments": { "type": "array", "items": {} } } } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": {}, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } } }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "integer" } } } } }, "examples": { "getWorkflowDocumentResponseExample": { "value": { "response": { "node": "e2e-staging-node", "data": [ { "workflow": { "typedId": "12356478.W", "workflowStatus": "APPROVED", "isSelectStepOnDeny": "false", "type": "quote", "steps": [ { "reason": "Total Price went over threshold.", "reasons": [ "Total Price went over threshold." ], "isUserApprover": "true", "userGroupNames": null, "type": "ApprovalWorkflowStep", "minApprovalsForGroups": [], "isPostStepLogicFailed": null, "postStepLogicName": null, "id": "132ca340-0b03-49db-8d60-29ecc06adb4a", "executedByNames": [ "admin" ], "userLoginNames": [ "admin" ], "userGroupTypedId": null, "approvalRequiredEmailAttachments": [], "subSteps": [ { "approver": "admin", "approverLoginName": "admin", "approverTypedId": "2147490696.U", "executionStatus": "EXECUTED_APPROVED", "lastExecutedBy": "admin", "lastExecutedByName": "admin", "approvedCount": 1, "minApprovalsNeeded": 1, "reason": "Total Price went over threshold.", "comment": "This version is ok.", "comments": null, "lastExecutionDate": "2021-10-27T12:54:54" } ], "executionStatus": "EXECUTED_APPROVED", "userTypedIds": [ "2147490696.U" ], "lastAccess": "2021-10-27T12:54:54", "minApprovalsNeeded": 1, "userName": "admin", "delegatedToTypedIds": [], "userGroupTypedIds": null, "userTypedId": "2147490696.U", "uniqueName": "approval", "denialReasons": [], "userGroupName": null, "isDenialReasonOptional": "true", "userNames": [ "admin" ], "comment": "This version is ok.", "mandatoryComments": [] } ], "approvableTypedId": "2147491331.Q", "currentStepId": null, "submitReason": null, "submitterUserName": "admin", "denialReasons": [], "submitterTypedId": "2147490696.U", "isDenialReasonOptional": "true", "id": "6fb030a8-3826-473e-9fe7-3f0a06b4870d", "isAddStepRestrictedToWFAdmin": "false" }, "resultType": "WORKFLOW" } ], "status": 0 } } } } } } } } }, "parameters": [ { "schema": { "type": "string", "example": "2147491330.Q" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the approvable object you want to retrieve workflow details for." } ] }, "/workflowsmanager.approve/{currentStepId}": { "parameters": [ { "schema": { "type": "string", "example": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef" }, "name": "currentStepId", "in": "path", "required": true, "description": "The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint." } ], "post": { "summary": "Approve a Document", "operationId": "post-workflowsmanager.approve-currentStepId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "approveDocumentResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": { "type": "object" } }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": { "type": "object" } }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "object" } }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "approver": { "type": "string", "minLength": 1 }, "approverLoginName": { "type": "string", "minLength": 1 }, "approverTypedId": { "type": "string", "minLength": 1 }, "executionStatus": { "type": "string", "minLength": 1 }, "lastExecutedBy": { "type": "string", "minLength": 1 }, "lastExecutedByName": { "type": "string", "minLength": 1 }, "approvedCount": { "type": "number" }, "minApprovalsNeeded": { "type": "number" }, "reason": { "type": "string", "minLength": 1 }, "comment": {}, "comments": {}, "lastExecutionDate": { "type": "string", "minLength": 1 } }, "required": [ "approver", "approverLoginName", "approverTypedId", "executionStatus", "lastExecutedBy", "lastExecutedByName", "approvedCount", "minApprovalsNeeded", "reason", "lastExecutionDate" ] } }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": { "type": "object" } }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": { "type": "object" } }, "comment": {}, "mandatoryComments": { "type": "array", "items": { "type": "object" } } }, "required": [ "reason", "isUserApprover", "type", "id", "executionStatus", "lastAccess", "minApprovalsNeeded", "userName", "userTypedId", "uniqueName", "isDenialReasonOptional" ] } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": {}, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } } }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow" ], "description": "Approves a document specified by the `currentStepId`. Allows you to add a comment in the request body.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "approveDocumentRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "actionComment": { "type": "string", "minLength": 1 } }, "required": [ "actionComment" ] } }, "required": [ "data" ] }, "examples": { "approveDocumentRequestExample": { "value": { "data": { "actionComment": "This version is ok." } } } } } } } } }, "/workflowsmanager.deny/{currentStepId}": { "parameters": [ { "schema": { "type": "string", "example": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef" }, "name": "currentStepId", "in": "path", "required": true, "description": "The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint." } ], "post": { "summary": "Deny a Document", "operationId": "post-workflowsmanager.deny-currentStepId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "denyDocumentResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": { "type": "object" } }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": { "type": "object" } }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "object" } }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "approver": { "type": "string", "minLength": 1 }, "approverLoginName": { "type": "string", "minLength": 1 }, "approverTypedId": { "type": "string", "minLength": 1 }, "executionStatus": { "type": "string", "minLength": 1 }, "lastExecutedBy": { "type": "string", "minLength": 1 }, "lastExecutedByName": { "type": "string", "minLength": 1 }, "approvedCount": { "type": "number" }, "minApprovalsNeeded": { "type": "number" }, "reason": { "type": "string", "minLength": 1 }, "comment": { "type": "string", "minLength": 1 }, "comments": {}, "lastExecutionDate": { "type": "string", "minLength": 1 } }, "required": [ "approver", "approverLoginName", "approverTypedId", "executionStatus", "lastExecutedBy", "lastExecutedByName", "approvedCount", "minApprovalsNeeded", "reason", "comment", "lastExecutionDate" ] } }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": { "type": "object" } }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": { "type": "object" } }, "comment": { "type": "string", "minLength": 1 }, "mandatoryComments": { "type": "array", "items": { "type": "object" } } }, "required": [ "reason", "isUserApprover", "type", "id", "executionStatus", "lastAccess", "minApprovalsNeeded", "userName", "userTypedId", "uniqueName", "isDenialReasonOptional", "comment" ] } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": {}, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } } }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } }, "examples": {} } } } }, "tags": [ "Workflow" ], "description": "Denies a document specified by the `currentStepId`. Allows you to add a comment in the request body.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "denyDocumentRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "actionComment": { "type": "string", "minLength": 1 } }, "required": [ "actionComment" ] } }, "required": [ "data" ] }, "examples": { "denyDocumentRequestExample": { "value": { "data": { "actionComment": "Not approved - the margin is too low." } } } } } } } } }, "/workflowsmanager.withdraw/{currentStepId}": { "parameters": [ { "schema": { "type": "string", "example": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef" }, "name": "currentStepId", "in": "path", "required": true, "description": "The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint." } ], "post": { "summary": "Withdraw a Document", "operationId": "post-workflowsmanager.withdraw-currentStepId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "withdrawDocumentResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": { "type": "object" } }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": { "type": "object" } }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "object" } }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "approver": { "type": "string", "minLength": 1 }, "approverLoginName": { "type": "string", "minLength": 1 }, "approverTypedId": { "type": "string", "minLength": 1 }, "executionStatus": { "type": "string", "minLength": 1 }, "lastExecutedBy": { "type": "string", "minLength": 1 }, "lastExecutedByName": { "type": "string", "minLength": 1 }, "approvedCount": { "type": "number" }, "minApprovalsNeeded": { "type": "number" }, "reason": { "type": "string", "minLength": 1 }, "comment": { "type": "string" }, "comments": {}, "lastExecutionDate": { "type": "string", "minLength": 1 } }, "required": [ "approver", "approverLoginName", "approverTypedId", "executionStatus", "lastExecutedBy", "lastExecutedByName", "approvedCount", "minApprovalsNeeded", "reason", "comment", "lastExecutionDate" ] } }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": { "type": "object" } }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": { "type": "object" } }, "comment": { "type": "string" }, "mandatoryComments": { "type": "array", "items": { "type": "object" } } }, "required": [ "reason", "isUserApprover", "type", "id", "executionStatus", "lastAccess", "minApprovalsNeeded", "userName", "userTypedId", "uniqueName", "isDenialReasonOptional", "comment" ] } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": {}, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } } }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow" ], "description": "Withdraws the document from the approval workflow (specified by the `currentStepId`)." } }, "/workflowsmanager.addapprover/{currentStepId}": { "parameters": [ { "schema": { "type": "string", "example": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef" }, "name": "currentStepId", "in": "path", "required": true, "description": "The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint." } ], "post": { "summary": "Add an Approver Step", "operationId": "post-workflowsmanager.addapprover-currentStepId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addApproverStepResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": { "type": "object" } }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": { "type": "object" } }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "object" } }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "approver": { "type": "string", "minLength": 1 }, "approverLoginName": { "type": "string", "minLength": 1 }, "approverTypedId": { "type": "string", "minLength": 1 }, "executionStatus": { "type": "string", "minLength": 1 }, "lastExecutedBy": { "type": "string", "minLength": 1 }, "lastExecutedByName": { "type": "string", "minLength": 1 }, "approvedCount": { "type": "number" }, "minApprovalsNeeded": { "type": "number" }, "reason": { "type": "string", "minLength": 1 }, "comment": { "type": "string" }, "comments": {}, "lastExecutionDate": { "type": "string", "minLength": 1 } }, "required": [ "approver", "approverLoginName", "approverTypedId", "executionStatus", "lastExecutedBy", "lastExecutedByName", "approvedCount", "minApprovalsNeeded", "reason", "comment", "lastExecutionDate" ] } }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": { "type": "object" } }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": { "type": "object" } }, "comment": { "type": "string" }, "mandatoryComments": { "type": "array", "items": { "type": "object" } } }, "required": [ "reason", "isUserApprover", "type", "id", "executionStatus", "lastAccess", "minApprovalsNeeded", "userName", "userTypedId", "uniqueName", "isDenialReasonOptional", "comment" ] } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": {}, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } } }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow" ], "description": "Adds an approver step to the workflow (specified by the `currentStepId`).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addApproverStepRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "addStepCurrentStepId", "addStepStepInstance" ], "properties": { "addStepCurrentStepId": { "type": "string", "minLength": 1 }, "addStepStepInstance": { "type": "object", "required": [ "uniqueName", "reason", "userLoginNames", "userGroupNames" ], "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "userLoginName": {}, "userGroupName": {}, "emailAttachment": { "type": "boolean" }, "properties": { "type": "object" }, "userLoginNames": { "type": "array", "description": "`userLoginNames` or `userGroupNames` must be provided.", "items": {} }, "userGroupNames": { "type": "array", "description": "`userLoginNames` or `userGroupNames` must be provided.", "items": { "type": "object" } }, "minApprovalsNeeded": { "type": "number" } } } } } }, "required": [ "data" ] }, "examples": { "addApproverStepRequestExample": { "value": { "data": { "addStepCurrentStepId": "448a0229-0488-4f3a-a13d-481936ad01dd", "addStepStepInstance": { "uniqueName": "Additional check", "reason": "Check this", "userLoginName": null, "userGroupName": null, "emailAttachment": false, "properties": {}, "userLoginNames": [ "JohnDoe" ], "userGroupNames": [], "minApprovalsNeeded": 1 } } } } } } } } } }, "/workflowsmanager.addwatcher/{currentStepId}": { "parameters": [ { "schema": { "type": "string", "example": "2d721e9d-ac6d-4eda-bd6c-60424f4fdaef" }, "name": "currentStepId", "in": "path", "required": true, "description": "The ID of the workflow step. It can be retrieved using the `/workflowsmanager.fetch/active` (**List Pending Approvals**) endpoint." } ], "post": { "summary": "Add a Watcher Step", "operationId": "post-workflowsmanager.addwatcher-currentStepId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addWatcherStepResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string", "minLength": 1 }, "isSelectStepOnDeny": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "steps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1 }, "reasons": { "type": "array", "items": { "type": "object" } }, "isUserApprover": { "type": "string", "minLength": 1 }, "userGroupNames": {}, "type": { "type": "string", "minLength": 1 }, "minApprovalsForGroups": { "type": "array", "items": { "type": "object" } }, "isPostStepLogicFailed": {}, "postStepLogicName": {}, "id": { "type": "string", "minLength": 1 }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "object" } }, "userGroupTypedId": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "approver": { "type": "string", "minLength": 1 }, "approverLoginName": { "type": "string", "minLength": 1 }, "approverTypedId": { "type": "string", "minLength": 1 }, "executionStatus": {}, "lastExecutedBy": {}, "lastExecutedByName": { "type": "string" }, "approvedCount": { "type": "number" }, "minApprovalsNeeded": { "type": "number" }, "reason": { "type": "string", "minLength": 1 }, "comment": {}, "comments": {}, "lastExecutionDate": {} }, "required": [ "approver", "approverLoginName", "approverTypedId", "lastExecutedByName", "approvedCount", "minApprovalsNeeded", "reason" ] } }, "executionStatus": { "type": "string", "minLength": 1 }, "userTypedIds": { "type": "array", "items": { "type": "object" } }, "lastAccess": { "type": "string", "minLength": 1 }, "minApprovalsNeeded": { "type": "number" }, "userName": { "type": "string", "minLength": 1 }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": {}, "userTypedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": {}, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "userNames": { "type": "array", "items": { "type": "object" } }, "comment": {}, "mandatoryComments": { "type": "array", "items": { "type": "object" } } }, "required": [ "reason", "isUserApprover", "type", "id", "executionStatus", "lastAccess", "minApprovalsNeeded", "userName", "userTypedId", "uniqueName", "isDenialReasonOptional" ] } }, "approvableTypedId": { "type": "string", "minLength": 1 }, "currentStepId": { "type": "string", "minLength": 1 }, "submitReason": {}, "submitterUserName": { "type": "string", "minLength": 1 }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "minLength": 1 }, "isDenialReasonOptional": { "type": "string", "minLength": 1 }, "id": { "type": "string", "minLength": 1 }, "isAddStepRestrictedToWFAdmin": { "type": "string", "minLength": 1 } }, "required": [ "isSelectStepOnDeny" ] }, "resultType": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow" ], "description": "Adds a watcher step to the workflow (specified by the `currentStepId`).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addWatcherStepRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "addStepCurrentStepId", "addStepStepInstance" ], "properties": { "addStepCurrentStepId": { "type": "string", "minLength": 1 }, "addStepStepInstance": { "type": "object", "required": [ "uniqueName", "reason", "properties", "userLoginNames", "userGroupNames" ], "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "reason": { "type": "string", "minLength": 1 }, "userLoginName": {}, "userGroupName": {}, "emailAttachment": { "type": "boolean" }, "properties": { "type": "object" }, "userLoginNames": { "type": "array", "items": { "type": "string" } }, "userGroupNames": { "type": "array", "items": { "type": "object" } }, "emails": {} } } } } }, "required": [ "data" ] }, "examples": { "addWatcherStepRequestExample": { "value": { "data": { "addStepCurrentStepId": "4c93094e-a9ba-4c84-aed7-fc5464742903", "addStepStepInstance": { "uniqueName": "Watcher Step", "reason": "Watch this", "userLoginName": null, "userGroupName": null, "emailAttachment": false, "properties": {}, "userLoginNames": [ "JohnDoe" ], "userGroupNames": [], "emails": null } } } } } } } } } }, "/quotemanager.save": { "post": { "summary": "Upsert a Quote", "operationId": "post-quotemanager.save", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Creates or updates a quote. To update a quote, specify an existing `uniqueName`.\n>This endpoint is not allowed to modify the document status and workflow status.\n\n---\n\n\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertQuoteRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "quote" ], "properties": { "quote": { "type": "object", "required": [ "version", "typedId", "uniqueName", "targetDate", "workflowStatus", "headerText", "inputs", "viewState", "outputs", "lastUpdateByName", "createdByName", "submittedByName", "calculationStatus", "dirty", "refreshInputs", "numberOfAttachments", "lineItems", "expiryDate", "customerId", "quoteStatus", "hasWorkflowHistory", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "prevRev", "rootUniqueName", "status" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} }, "required": [ "name", "label", "url", "type", "value", "valueHint" ] } }, "viewState": { "type": "object", "required": [ "selectedNodes" ], "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": { "type": "array", "items": { "type": "string" } } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "clicId": { "type": "number" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "number" }, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName", "resultLabel", "result", "excludeFromExport", "displayOptions", "formatType", "resultType", "overrideAllowEmpty", "overridable", "overridden" ] } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "priceRecordId": {}, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } }, "required": [ "version", "typedId", "clicId", "dirty", "lineId", "calculationStatus", "editabilityStatus", "label", "sku", "folder", "treeLabel", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ] } }, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "customerId": { "type": "string", "minLength": 1 }, "customerName": {}, "customerGroup": {}, "quoteStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": {}, "deniedByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": { "type": "string", "minLength": 1 }, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": {}, "status": { "type": "string", "minLength": 1 } } } } } }, "required": [ "data" ] }, "examples": { "createQuoteRequestExample": { "value": { "data": { "quote": { "version": 5, "typedId": "2147491342.Q", "uniqueName": "P-2147491340-REV-2", "label": "Quote01", "targetDate": "2021-11-01", "workflowStatus": "DRAFT", "headerText": "

Quote message.

", "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": "00003", "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": [ "0pnOfOZ0RNyO8LA", "n0MnhY2gThX7adD", "IZpgAGs8pCAxG2p" ] }, "outputs": [], "lastUpdateByName": "root", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": 3, "typedId": "2147515659.QLI", "clicId": 2147491342, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "0pnOfOZ0RNyO8LA", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label One", "sku": "11111", "priceRecordId": null, "folder": false, "treeLabel": "Label One", "createDate": "2021-11-02T09:12:58", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T09:12:58", "lastUpdateBy": 1 }, { "version": 3, "typedId": "2147515660.QLI", "clicId": 2147491342, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "n0MnhY2gThX7adD", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label Two", "sku": "22222", "priceRecordId": null, "folder": false, "treeLabel": "Label Two", "createDate": "2021-11-02T09:12:58", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T09:12:58", "lastUpdateBy": 1 }, { "version": 3, "typedId": "2147515661.QLI", "clicId": 2147491342, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "IZpgAGs8pCAxG2p", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label Three", "sku": "33333", "priceRecordId": null, "folder": false, "treeLabel": "Label Three", "createDate": "2021-11-02T09:12:58", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T09:12:58", "lastUpdateBy": 1 } ], "expiryDate": "2021-11-01", "externalRef": null, "customerId": "00003", "customerName": null, "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": null, "serverMessagesExtended": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "approvedByName": null, "deniedByName": null, "createDate": "2021-11-01T17:20:17", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T09:12:58", "lastUpdateBy": 1, "supersededBy": null, "prevRev": "P-2147491340", "rootUniqueName": "P-2147491340", "quoteType": null, "status": "DRAFT" } } } } } } } } } }, "/quotemanager.fetchlist": { "post": { "summary": "List Quotes", "operationId": "post-quotemanager.fetchlist", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listQuotesResponse", "properties": { "response": { "type": "object", "required": [ "data" ], "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "numberOfAttachments": { "type": "number" }, "expiryDate": { "type": "string", "minLength": 1 }, "quoteStatus": { "type": "string", "minLength": 1 }, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "prevRev": { "type": "string", "minLength": 1 }, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "listQuotesResponseExample": { "value": { "response": { "node": "", "startRow": 0, "data": [ { "version": 10, "typedId": "2147491331.Q", "uniqueName": "P-2147491330-REV-1", "label": "New QuoteWF", "targetDate": "2021-10-26", "workflowStatus": "APPROVED", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "numberOfAttachments": 0, "expiryDate": "2021-10-26", "quoteStatus": "OFFER", "hasWorkflowHistory": true, "approvedByName": "admin", "createDate": "2021-10-27T12:52:58", "createdBy": 2147490696, "lastUpdateDate": "2021-10-27T16:07:06", "lastUpdateBy": 2147490696, "prevRev": "P-2147491330", "rootUniqueName": "P-2147491330", "quoteType": "default", "status": "DRAFT" } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "description": "Retrieves all quotes. You can also filter the returned data.\n\n---\n**Filter example**:

\nReturns only first 10 quotes with *workflowStatus* = `APPROVED` and *quoteStatus* = `OFFER`.\n```json\n{\n \"endRow\":10,\n \"oldValues\": null,\n \"operationType\":\"fetch\",\n \"startRow\":0,\n \"textMatchStyle\":\"exact\",\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"workflowStatus\",\n \"operator\":\"equals\",\n \"value\":\"APPROVED\"\n },\n {\n \"fieldName\":\"quoteStatus\",\n \"operator\":\"equals\",\n \"value\":\"OFFER\"\n }\n ]\n }\n}\n```\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_FETCHFILTERED | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Data Integration (`DATAINTEGRATION`), View Competition Data (`PB_COMPETITION_RO`), View Products (`PB_PRODUCTS_RO`), Administer Price Lists (`PB_PRICELISTS`), Manage Products (`PB_PRODUCTEDITOR`), Manage Price Lists (`PB_PRICELISTSEDITOR`), Administer LPG (`PB_PRICEGRIDS`), Manage BoM Data (`PB_BOM`), Administer Products (`PB_PRODUCTS`), View QuoteConfigurator (`PRICESHOP_RO`) Manage Product Master (`PB_PRODUCTS_ONLY`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage PromotionManager (`CM_CONTRACTMANAGER`), Edit Quoting (`PRICESHOP_EDIT`) Administer Rebates (`RM_REBATEMANAGER`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), View Product Details (`PB_PDETAILSVIEW`), Manage Product Details Only (`PB_PDETAILSEDITOR`), Manage Claims (`CLM_CLAIMMANAGER`), Manage Product Master Extensions (`PB_PXEDITOR`), View BoM Data (`PB_BOM_RO`), Manage Products & Use EC (`PB_PRODUCTEDITOR_EC`), Manage Competition Data (`PB_COMPETITION`), Manage QuoteConfigurator (`PRICESHOP`), View Price Lists (`PB_PRICELISTS_RO`)", "tags": [ "Quotes" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listQuotesRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listQuotesRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "quoteStatus", "operator": "equals", "value": "DEAL" } ] } } } } } } } } }, "/quotemanager.fetch/{typedID}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedID", "in": "path", "required": true, "description": "Enter the quote typed ID. You get the `typedId` in the response when fetching all quotes using the `/quotemanager.fetchlist` endpoint." } ], "post": { "summary": "Get a Quote", "operationId": "post-quotemanager.fetch-typedID", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Retrieves quote details.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_FETCHFILTERED | View Quoting (`PRICESHOP_RO`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`), Manage Workflow Logics (`WF_BUILDER`)" } }, "/quotemanager.submit": { "post": { "summary": "Submit a Quote", "operationId": "post-quotemanager.submit", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Submits a specified quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "submitQuoteRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "quote" ], "properties": { "quote": { "type": "object", "required": [ "typedId", "uniqueName", "inputs" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": { "type": "array", "items": { "type": "object" } } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "clicId": { "type": "number" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "number" }, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName", "resultLabel", "result", "excludeFromExport", "displayOptions", "formatType", "resultType", "overrideAllowEmpty", "overridable", "overridden" ] } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "priceRecordId": {}, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "customerId": { "type": "string", "minLength": 1 }, "customerName": { "type": "string", "minLength": 1 }, "customerGroup": {}, "quoteStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": {}, "deniedByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": { "type": "string", "minLength": 1 }, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": {}, "status": { "type": "string", "minLength": 1 } } } } } }, "required": [ "data" ] } } } } } }, "/quotemanager.fetchxls/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "P-2147491340-REV-3" }, "name": "uniqueName", "in": "path", "required": true, "description": "Specify the `uniqueName` of the quote you want to download." } ], "post": { "summary": "Export an Excel File", "operationId": "post-quotemanager.exportxls-uniqueName", "responses": { "200": { "description": "OK - returns a file data." } }, "tags": [ "Quotes" ], "description": "Downloads the XLSX file of the specified quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_FETCHFILTERED | View Quoting (`PRICESHOP_RO`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`), Manage Workflow Logics (`WF_BUILDER`)", "parameters": [ { "$ref": "#/components/parameters/templateName" }, { "$ref": "#/components/parameters/output" } ] } }, "/quotemanager.fetchdocx/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "P-2147491340-REV-3" }, "name": "uniqueName", "in": "path", "required": true, "description": "Specify the `uniqueName` of the quote you want to download." } ], "post": { "summary": "Export a DOCX File", "operationId": "post-quotemanager.exportdocx-uniqueName", "responses": { "200": { "description": "OK" } }, "tags": [ "Quotes" ], "description": "Downloads the DOCX file of the specified quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_FETCHFILTERED | View Quoting (`PRICESHOP_RO`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`), Manage Workflow Logics (`WF_BUILDER`)", "parameters": [ { "$ref": "#/components/parameters/templateName" }, { "$ref": "#/components/parameters/output" } ] } }, "/quotemanager.fetchpdf/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "P-2147491340-REV-3" }, "name": "uniqueName", "in": "path", "required": true, "description": "Specify the `uniqueName` of the quote you want to download." } ], "post": { "summary": "Export a PDF File", "operationId": "post-quotemanager.fetchtpdf-uniqueName", "responses": { "200": { "description": "OK - returns the file data.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "tags": [ "Quotes" ], "description": "Downloads the PDF file of the specified quote. CloudConvert must be enabled (**Administration** > **Configuration** > **External Systems** > **CloudConvert**).", "parameters": [ { "$ref": "#/components/parameters/output" }, { "$ref": "#/components/parameters/dataLocale" }, { "$ref": "#/components/parameters/templateName" } ] } }, "/contractmanager.fetchpdf/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "C-170" }, "name": "uniqueName", "in": "path", "required": true, "description": "Specify the `uniqueName` of the A&P you want to download." } ], "post": { "summary": "Export a PDF File", "operationId": "post-contractmanager.exportpdf-uniqueName", "responses": { "200": { "description": "OK - returns the file data.", "content": { "application/pdf": { "schema": { "type": "object", "properties": {} } } } } }, "description": "Downloads the PDF file of the specified A&P. CloudConvert must be enabled (**Administration** > **Configuration** > **External Systems** > **CloudConvert**).", "tags": [ "Contracts (Agreements & Promotions)" ] } }, "/quotemanager.price": { "post": { "summary": "Recalculate a Quote", "operationId": "post-quotemanager.price", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "description": "Recalculates the price of the entire quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\nQUOTE_PRICE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "recalculateQuoteRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "quote" ], "properties": { "quote": { "type": "object", "required": [ "version", "typedId", "uniqueName", "label", "targetDate", "workflowStatus", "headerText", "inputs", "viewState", "outputs", "lastUpdateByName", "createdByName", "submittedByName", "calculationStatus", "dirty", "refreshInputs", "numberOfAttachments", "lineItems", "expiryDate", "customerId", "customerName", "quoteStatus", "hasWorkflowHistory", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "prevRev", "rootUniqueName", "status" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} }, "required": [ "name", "label", "url", "type", "value", "valueHint" ] } }, "viewState": { "type": "object", "required": [ "selectedNodes" ], "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": { "type": "array", "items": { "type": "object" } } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "clicId": { "type": "number" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "number" }, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName", "resultLabel", "result", "excludeFromExport", "displayOptions", "formatType", "resultType", "overrideAllowEmpty", "overridable", "overridden" ] } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "priceRecordId": {}, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } }, "required": [ "version", "typedId", "clicId", "dirty", "lineId", "calculationStatus", "editabilityStatus", "label", "sku", "folder", "treeLabel", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ] } }, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "customerId": { "type": "string", "minLength": 1 }, "customerName": { "type": "string", "minLength": 1 }, "customerGroup": {}, "quoteStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": {}, "deniedByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": { "type": "string", "minLength": 1 }, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": {}, "status": { "type": "string", "minLength": 1 } } } } } }, "required": [ "data" ] } } } }, "tags": [ "Quotes" ] } }, "/quotemanager.fetchproducts": { "post": { "summary": "List Products", "operationId": "post-quotemanager.fetchproducts", "responses": { "200": { "description": "OK" } }, "tags": [ "Quotes" ], "description": "Retrieves product records. Additionally to the `/productmanager.fetchproducts` endpoint, this command supports filtering by a custom formula set for the configured and evaluated quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_FETCHFILTERED | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Data Integration (`DATAINTEGRATION`), View Competition Data (`PB_COMPETITION_RO`), View Products (`PB_PRODUCTS_RO`), Administer Price Lists (`PB_PRICELISTS`), Manage Products (`PB_PRODUCTEDITOR`), Manage Price Lists (`PB_PRICELISTSEDITOR`), Administer LPG (`PB_PRICEGRIDS`), Manage BoM Data (`PB_BOM`), Administer Products (`PB_PRODUCTS`), View QuoteConfigurator (`PRICESHOP_RO`) Manage Product Master (`PB_PRODUCTS_ONLY`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage PromotionManager (`CM_CONTRACTMANAGER`), Edit Quoting (`PRICESHOP_EDIT`) Administer Rebates (`RM_REBATEMANAGER`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), View Product Details (`PB_PDETAILSVIEW`), Manage Product Details Only (`PB_PDETAILSEDITOR`), Manage Claims (`CLM_CLAIMMANAGER`), Manage Product Master Extensions (`PB_PXEDITOR`), View BoM Data (`PB_BOM_RO`), Manage Products & Use EC (`PB_PRODUCTEDITOR_EC`), Manage Competition Data (`PB_COMPETITION`), Manage QuoteConfigurator (`PRICESHOP`), View Price Lists (`PB_PRICELISTS_RO`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listProductsRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "oldValues": {}, "distinctResults": { "type": "boolean" }, "data": { "type": "object", "required": [ "quote", "filterCriteria" ], "properties": { "quote": { "type": "object", "required": [ "label", "targetDate", "headerText", "inputs", "outputs", "expiryDate" ], "properties": { "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} }, "required": [ "name", "label", "url", "type", "value", "valueHint" ] } }, "outputs": { "type": "array", "items": { "type": "object" } }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "quoteType": {} } }, "filterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "items": { "type": "object" } } } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "sortBy": { "type": "array", "items": {} } }, "required": [ "data", "endRow", "sortBy" ] }, "examples": { "listProductsRequestExample": { "value": { "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "oldValues": null, "distinctResults": false, "data": { "quote": { "label": "Quote01", "targetDate": "2021-11-01", "headerText": "

Quote message.

", "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": "00003", "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "outputs": [], "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "expiryDate": "2021-11-01", "externalRef": null, "quoteType": null }, "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "unitOfMeasure", "operator": "iContains", "value": "EA" } ] } }, "endRow": 50, "sortBy": [ "sku" ] } } } } } } } }, "/quotemanager.createnewrevision/{identifier}": { "parameters": [ { "schema": { "type": "string", "example": "2147491342.Q" }, "name": "identifier", "in": "path", "required": true, "description": "Can be either the `uniqueName` or the `typedId`." } ], "post": { "summary": "Create a New Revision", "operationId": "post-quotemanager.createnewrevision-identifier", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Creates a new revision of the quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)" } }, "/quotemanager.convert/{identifier}": { "parameters": [ { "schema": { "type": "string", "example": "P-2147491330-REV-1" }, "name": "identifier", "in": "path", "required": true, "description": "Can be either the `uniqueName` or the `typedId`." } ], "post": { "summary": "Convert to a Deal", "operationId": "post-quotemanager.convert-identifier", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "description": "Sets a `quoteStatus` to `DEAL`.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "tags": [ "Quotes" ] } }, "/quotemanager.copy/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Copy a Quote", "operationId": "post-quotemanager.copy-identifier", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "response": { "node": "pricefx-cluster-app-frontend-55f47cdfc7-6vtdz", "data": [ { "version": 16, "typedId": "2147495330.Q", "uniqueName": "P-2147495330", "label": "Copy of Quote01", "targetDate": "2026-03-04", "workflowStatus": "DRAFT", "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": "00003", "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "userGroupEdit": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "userGroupView": null, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": [ "1YVskopFH3wKwY3", "oQzhFI689u3vFJ9", "QugyKVN4Yvzl95Q" ], "validationSnapshot": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": true, "refreshInputs": true, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "creationWorkflowCurrentStepIsReview": false, "creationWorkflowInfo": null, "reviewSubStepInfo": null, "originDeleted": false, "originLabel": "Quote01", "originUniqueName": "P-2147491340-REV-2", "expiryDate": "2026-03-04", "externalRef": null, "customerId": "00003", "customerName": "Kate Smith", "originClicId": 2147491342, "lostReason": null, "lostReasonComment": null, "customerGroup": null, "quoteStatus": "DRAFT", "locked": false, "approvalRequiredEmailAttachmentsJson": null, "renderInfo": null, "serverMessagesExtended": null, "approvedByName": null, "deniedByName": null, "createDate": "2026-03-04T12:36:45", "createdBy": 2147490696, "lastUpdateDate": "2026-03-04T12:36:45", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "P-2147495330", "lastCalculationDate": null, "quoteType": null, "status": "DRAFT" } ], "status": 0 } } }, "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "targetDate": { "type": "string" }, "workflowStatus": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "nullable": true }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "nullable": true }, "filter": { "nullable": true }, "parameterGroup": { "nullable": true }, "required": { "nullable": true }, "labelTranslations": { "nullable": true }, "addUnknownValues": { "nullable": true }, "typedId": { "nullable": true }, "alwaysEditable": { "nullable": true }, "userGroupEdit": { "nullable": true }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "userGroupView": { "nullable": true }, "valueOptions": { "nullable": true } } } }, "viewState": { "type": "object", "properties": { "gridViewState": { "nullable": true }, "openFolders": { "nullable": true }, "selectedNodes": { "type": "array", "items": { "type": "string" } }, "validationSnapshot": { "nullable": true } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string" }, "createdByName": { "type": "string" }, "submittedByName": { "nullable": true }, "calculationStatus": { "type": "integer" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": { "type": "string", "nullable": true }, "userGroupEdit": { "nullable": true }, "userGroupViewDetails": { "nullable": true }, "serverMessages": { "nullable": true }, "additionalInfo1": { "nullable": true }, "additionalInfo2": { "nullable": true }, "additionalInfo3": { "nullable": true }, "additionalInfo4": { "nullable": true }, "numberOfAttachments": { "type": "integer" }, "creationWorkflowStatus": { "nullable": true }, "creationWorkflowCurrentStep": { "nullable": true }, "creationWorkflowStepCount": { "nullable": true }, "creationWorkflowStepLabel": { "nullable": true }, "creationWorkflowCurrentStepIsReview": { "type": "boolean" }, "creationWorkflowInfo": { "nullable": true }, "reviewSubStepInfo": { "nullable": true }, "originDeleted": { "type": "boolean" }, "originLabel": { "type": "string" }, "originUniqueName": { "type": "string" }, "expiryDate": { "type": "string" }, "externalRef": { "nullable": true }, "customerId": { "type": "string" }, "customerName": { "type": "string" }, "originClicId": { "type": "integer" }, "lostReason": { "nullable": true }, "lostReasonComment": { "nullable": true }, "customerGroup": { "nullable": true }, "quoteStatus": { "type": "string" }, "locked": { "type": "boolean" }, "approvalRequiredEmailAttachmentsJson": { "nullable": true }, "renderInfo": { "nullable": true }, "serverMessagesExtended": { "nullable": true }, "approvedByName": { "nullable": true }, "deniedByName": { "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "supersededBy": { "nullable": true }, "prevRev": { "nullable": true }, "rootUniqueName": { "type": "string" }, "lastCalculationDate": { "nullable": true }, "quoteType": { "nullable": true }, "status": { "type": "string" } } } }, "status": { "type": "integer" } } } } } } } } }, "description": "Creates a copy of the specified quote.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "tags": [ "Quotes" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/quotemanager.changestatus/{identifier}": { "parameters": [ { "schema": { "type": "string" }, "name": "identifier", "in": "path", "required": true, "description": "Can be either the `uniqueName` or the `typedId`." } ], "post": { "summary": "Mark an Offer as Lost", "operationId": "post-quotemanager.changestatus-typedId", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Changes `quoteStatus` from `OFFER` to `LOST`.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "markOfferAsLostRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "targetStatus": { "type": "string", "minLength": 1 } }, "required": [ "targetStatus" ] } }, "required": [ "data" ] }, "examples": { "markOfferLostRequestExample": { "value": { "data": { "targetStatus": "LOST" } } } } } } } } }, "/quotemanager.revoke/{identifier}": { "parameters": [ { "schema": { "type": "string" }, "name": "identifier", "in": "path", "required": true, "description": "Can be either the `uniqueName` or the `typedId`." } ], "post": { "summary": "Revoke a Deal", "operationId": "post-quotemanager.revoke-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "revokeDealResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "Quotes" ], "description": "Sets `quoteStatus` to `REVOKED`.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_REVOKE | Administer QuoteConfigurator (`PRICESHOP_QUOTEADMIN`)" } }, "/quotemanager.addproducts": { "post": { "summary": "Add Products to a Quote", "operationId": "post-quotemanager.addproducts", "responses": { "200": { "$ref": "#/components/responses/quoteResponse" } }, "tags": [ "Quotes" ], "description": "Adds specified product items to the quote. The quote is recalculated after the items are added.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n QUOTE_UPDATE | Edit Quoting (`PRICESHOP_EDIT`), Administer Quoting (`PRICESHOP_QUOTEADMIN`), Manage Quoting (`PRICESHOP`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addProductsToQuoteRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "quote", "skus" ], "properties": { "quote": { "type": "object", "required": [ "version", "typedId", "uniqueName", "label", "targetDate", "workflowStatus", "headerText", "inputs", "viewState", "outputs", "lastUpdateByName", "createdByName", "calculationStatus", "dirty", "refreshInputs", "numberOfAttachments", "lineItems", "expiryDate", "customerId", "customerName", "quoteStatus", "hasWorkflowHistory", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "rootUniqueName", "quoteType", "status" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} }, "required": [ "name", "label", "url", "type", "value", "valueHint" ] } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "customerId": { "type": "string", "minLength": 1 }, "customerName": { "type": "string", "minLength": 1 }, "customerGroup": {}, "quoteStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": {}, "deniedByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 } } }, "parent": {}, "skus": { "type": "array", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "addProductsToQuoteRequestExample": { "value": { "data": { "quote": { "version": 3, "typedId": "2147491354.Q", "uniqueName": "P-2147491354", "label": "New Quote 2021", "targetDate": "2021-11-02", "workflowStatus": "DRAFT", "headerText": "

Quote 2021

", "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": "00003", "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "expiryDate": "2021-11-30", "externalRef": null, "customerId": "00003", "customerName": "Kate Smith", "customerGroup": null, "quoteStatus": "DRAFT", "renderInfo": null, "serverMessagesExtended": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "approvedByName": null, "deniedByName": null, "createDate": "2021-11-02T16:41:33", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T16:41:33", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "P-2147491354", "quoteType": "default", "status": "DRAFT" }, "parent": null, "skus": [ "11111", "22222", "33333" ] } } } } } } } } }, "/pricegridmanager.accept/{id}": { "post": { "summary": "Submit Products", "operationId": "post-pricegridmanager.accept", "responses": { "200": { "description": "OK - In case that more than one item is passed in the request, the body will not contain any data (`\"data\":null`). For a single item, the new PriceGridItem object is returned.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "submitProductsResponse", "properties": { "response": { "type": "object", "required": [ "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "comments": {}, "resultPrice": { "type": "number" }, "previousPrice": {}, "priceChange": {}, "priceChangePct": {}, "workStatus": {}, "alerts": {}, "warnings": {}, "allowedOverrides": { "type": "string" }, "manualOverrides": {}, "manualResultPrice": {}, "calculatedResultPrice": { "type": "number" }, "priceGridId": { "type": "number" }, "approvalState": { "type": "string", "minLength": 1 }, "denialReason": {}, "activePrice": {}, "priceChange_ActivePrev": {}, "priceChangePct_ActivePrev": {}, "manualEditVersion": { "type": "number" }, "manualPriceExpired": { "type": "boolean" }, "workflowStatus": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "key2": { "type": "string", "minLength": 1 }, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachments": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": { "type": "number" }, "attribute2": { "type": "number" }, "attribute3": { "type": "number" }, "attribute4": { "type": "number" }, "attribute5": { "type": "number" }, "attribute6": { "type": "number" }, "attribute7": { "type": "number" }, "attribute8": { "type": "number" }, "attribute9": { "type": "number" }, "attribute10": { "type": "number" }, "attribute11": { "type": "number" }, "attribute12": { "type": "number" }, "attribute13": { "type": "number" }, "attribute14": { "type": "number" }, "attribute15": { "type": "number" }, "attribute16": { "type": "number" }, "attribute17": { "type": "number" }, "attribute18": { "type": "number" }, "attribute19": { "type": "number" }, "attribute20": { "type": "number" }, "attribute21": { "type": "number" }, "attribute22": { "type": "number" }, "attribute23": { "type": "number" }, "attribute24": { "type": "number" }, "attribute25": { "type": "number" }, "attribute26": { "type": "number" }, "attribute27": { "type": "number" }, "attribute28": { "type": "number" }, "attribute29": { "type": "number" }, "attribute30": { "type": "number" }, "attribute31": { "type": "number" }, "attribute32": { "type": "number" }, "attribute33": { "type": "number" }, "attribute34": { "type": "number" }, "attribute35": { "type": "number" }, "attribute36": { "type": "number" }, "attribute37": { "type": "number" }, "attribute38": { "type": "number" }, "attribute39": { "type": "number" }, "attribute40": { "type": "number" }, "attribute41": { "type": "number" }, "attribute42": { "type": "number" }, "attribute43": { "type": "number" }, "attribute44": { "type": "number" }, "attribute45": { "type": "number" }, "attribute46": { "type": "number" }, "attribute47": { "type": "number" }, "attribute48": { "type": "number" }, "attribute49": { "type": "number" }, "attribute50": { "type": "number" }, "attribute51": { "type": "number" }, "attribute52": { "type": "number" }, "attribute53": { "type": "number" }, "attribute54": { "type": "number" }, "attribute55": { "type": "number" }, "attribute56": { "type": "number" }, "attribute57": { "type": "number" }, "attribute58": { "type": "number" }, "attribute59": { "type": "number" }, "attribute60": { "type": "number" }, "attribute61": { "type": "number" }, "attribute62": { "type": "number" }, "attribute63": { "type": "number" }, "attribute64": { "type": "number" }, "attribute65": { "type": "number" }, "attribute66": { "type": "number" }, "attribute67": { "type": "number" }, "attribute68": { "type": "number" }, "attribute69": { "type": "number" }, "attribute70": { "type": "number" }, "attribute71": { "type": "number" }, "attribute72": { "type": "number" }, "attribute73": { "type": "number" }, "attribute74": { "type": "number" }, "attribute75": { "type": "number" }, "attribute76": { "type": "number" }, "attribute77": { "type": "number" }, "attribute78": { "type": "number" }, "attribute79": { "type": "number" }, "attribute80": { "type": "number" }, "attribute81": { "type": "number" }, "attribute82": { "type": "number" }, "attribute83": { "type": "number" }, "attribute84": { "type": "number" }, "attribute85": { "type": "number" }, "attribute86": { "type": "number" }, "attribute87": { "type": "number" }, "attribute88": { "type": "number" }, "attribute89": { "type": "number" }, "attribute90": {}, "attribute91": {}, "attribute92": {}, "attribute93": {}, "attribute94": {}, "attribute95": {}, "attribute96": {}, "attribute97": {}, "attribute98": {}, "attribute99": {}, "attribute100": {}, "approvalDate": {}, "denialDate": {}, "previousPriceDate": {}, "activePriceDate": {}, "manualEditUser": { "type": "number" }, "manualPriceDate": {}, "submitDate": { "type": "string", "minLength": 1 }, "completeResultsAvailable": { "type": "boolean" }, "itemExtensions": { "type": "object", "properties": { "cellStyles": { "type": "object", "properties": { "attribute19": { "type": "string", "minLength": 1 }, "attribute18": { "type": "string", "minLength": 1 }, "attribute39": { "type": "string", "minLength": 1 }, "attribute38": { "type": "string", "minLength": 1 }, "attribute15": { "type": "string", "minLength": 1 }, "attribute37": { "type": "string", "minLength": 1 }, "attribute25": { "type": "string", "minLength": 1 }, "attribute24": { "type": "string", "minLength": 1 }, "attribute23": { "type": "string", "minLength": 1 }, "attribute22": { "type": "string", "minLength": 1 }, "attribute21": { "type": "string", "minLength": 1 }, "attribute20": { "type": "string", "minLength": 1 }, "attribute41": { "type": "string", "minLength": 1 }, "attribute40": { "type": "string", "minLength": 1 }, "attribute29": { "type": "string", "minLength": 1 }, "attribute28": { "type": "string", "minLength": 1 }, "attribute27": { "type": "string", "minLength": 1 }, "attribute26": { "type": "string", "minLength": 1 }, "attribute9": { "type": "string", "minLength": 1 }, "attribute8": { "type": "string", "minLength": 1 }, "attribute5": { "type": "string", "minLength": 1 }, "attribute4": { "type": "string", "minLength": 1 }, "attribute7": { "type": "string", "minLength": 1 }, "attribute6": { "type": "string", "minLength": 1 }, "attribute36": { "type": "string", "minLength": 1 }, "attribute35": { "type": "string", "minLength": 1 }, "attribute3": { "type": "string", "minLength": 1 }, "attribute34": { "type": "string", "minLength": 1 }, "attribute2": { "type": "string", "minLength": 1 }, "attribute33": { "type": "string", "minLength": 1 }, "attribute32": { "type": "string", "minLength": 1 }, "attribute31": { "type": "string", "minLength": 1 }, "attribute30": { "type": "string", "minLength": 1 }, "attribute42": { "type": "string", "minLength": 1 }, "attribute43": { "type": "string", "minLength": 1 }, "attribute44": { "type": "string", "minLength": 1 }, "attribute45": { "type": "string", "minLength": 1 }, "attribute46": { "type": "string", "minLength": 1 }, "attribute47": { "type": "string", "minLength": 1 }, "attribute48": { "type": "string", "minLength": 1 }, "attribute49": { "type": "string", "minLength": 1 }, "attribute50": { "type": "string", "minLength": 1 }, "attribute51": { "type": "string", "minLength": 1 }, "attribute52": { "type": "string", "minLength": 1 }, "attribute53": { "type": "string", "minLength": 1 }, "attribute54": { "type": "string", "minLength": 1 }, "attribute55": { "type": "string", "minLength": 1 }, "attribute56": { "type": "string", "minLength": 1 }, "attribute57": { "type": "string", "minLength": 1 }, "attribute58": { "type": "string", "minLength": 1 }, "attribute59": { "type": "string", "minLength": 1 }, "attribute60": { "type": "string", "minLength": 1 }, "attribute61": { "type": "string", "minLength": 1 }, "attribute62": { "type": "string", "minLength": 1 }, "attribute63": { "type": "string", "minLength": 1 }, "attribute64": { "type": "string", "minLength": 1 }, "attribute65": { "type": "string", "minLength": 1 }, "attribute66": { "type": "string", "minLength": 1 }, "attribute67": { "type": "string", "minLength": 1 }, "attribute68": { "type": "string", "minLength": 1 }, "attribute69": { "type": "string", "minLength": 1 }, "attribute70": { "type": "string", "minLength": 1 }, "attribute71": { "type": "string", "minLength": 1 }, "attribute72": { "type": "string", "minLength": 1 }, "attribute73": { "type": "string", "minLength": 1 }, "attribute74": { "type": "string", "minLength": 1 }, "attribute75": { "type": "string", "minLength": 1 }, "attribute76": { "type": "string", "minLength": 1 }, "attribute77": { "type": "string", "minLength": 1 }, "attribute78": { "type": "string", "minLength": 1 }, "attribute79": { "type": "string", "minLength": 1 }, "attribute80": { "type": "string", "minLength": 1 }, "attribute81": { "type": "string", "minLength": 1 }, "attribute82": { "type": "string", "minLength": 1 }, "attribute83": { "type": "string", "minLength": 1 }, "attribute84": { "type": "string", "minLength": 1 }, "attribute85": { "type": "string", "minLength": 1 }, "attribute86": { "type": "string", "minLength": 1 }, "attribute87": { "type": "string", "minLength": 1 }, "attribute88": { "type": "string", "minLength": 1 }, "attribute89": { "type": "string", "minLength": 1 }, "attribute10": { "type": "string", "minLength": 1 }, "attribute11": { "type": "string", "minLength": 1 }, "attribute12": { "type": "string", "minLength": 1 }, "attribute13": { "type": "string", "minLength": 1 }, "attribute14": { "type": "string", "minLength": 1 }, "attribute16": { "type": "string", "minLength": 1 }, "attribute17": { "type": "string", "minLength": 1 } } } }, "required": [ "cellStyles" ] } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Live Price Grids" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "submitProductsRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "ids": { "type": "array", "description": "Specify `typedId`s of items you want to accept.", "items": { "properties": {} } } }, "required": [ "ids" ] } }, "required": [ "data" ] }, "examples": { "submitProductsLPGRequestExample": { "value": { "data": { "ids": [ "12.XPGI", "13.XPGI", "17.XPGI", "18.XPGI", "19.XPGI" ] } } } } } } }, "description": "Submits the `PriceGridItems` to the workflow.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_SUBMIT | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)" }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Live Price Grid you want to submit items for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ] }, "/fetch/PG": { "post": { "summary": "List Live Price Grids", "operationId": "post-fetch-PG", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listLivePriceGridsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "numberOfApprovedItems": { "type": "number" }, "numberOfOpenItems": { "type": "number" }, "numberOfDeniedItems": { "type": "number" }, "numberOfSubmittedItems": { "type": "number" }, "numberOfAutoApprovedItems": { "type": "number" }, "priceGridType": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updateDate": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "partialCalculationDate": { "type": "string", "minLength": 1 }, "id": { "type": "number" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 } } } } } } } } }, "tags": [ "Live Price Grids" ], "description": "Retrieves all Price Grids based on filter settings.\n\n---\n**Filter example**:

\nReturns only Price Grids where *status* = `CANCELLED`.\n```json\n{\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"status\",\n \"operator\":\"equals\",\n \"value\":\"CANCELLED\"\n }\n ]\n }\n}\n```\n\n---", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listLivePriceGridsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listLPGRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "equals", "value": "READY" } ] } } } } } } } } }, "/fetch/PG/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Live Price Grid you want to retrieve details for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Get a Live Price Grid", "operationId": "post-fetch-PG-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getLivePriceGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "numberOfApprovedItems": { "type": "number" }, "numberOfOpenItems": { "type": "number" }, "numberOfDeniedItems": { "type": "number" }, "numberOfSubmittedItems": { "type": "number" }, "numberOfAutoApprovedItems": { "type": "number" }, "priceGridType": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updateDate": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "partialCalculationDate": { "type": "string", "minLength": 1 }, "id": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Live Price Grids" ], "description": "Retrieves details of the specified Live Price Grid." } }, "/pricegridmanager.fetch/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Live Price Grid you want to retrieve items for. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "List Live Price Grid Items", "operationId": "post-pricegridmanager.fetch-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listLivePriceGridItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "priceGridId": { "type": "number" }, "manualEditVersion": { "type": "number" }, "manualPriceExpired": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "itemExtensions": { "type": "object" }, "completeResultsAvailable": { "type": "boolean" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Live Price Grids" ], "description": "Retrieves Live Price Grid Items.

\nA filter can be applied.

\n**Filter example**:

\nReturns the item where `id` = 644.\n\n> #### Please note:\n> Filtering by `typedId` is not accepted by this enpoint.\n```json\n{\n \"endRow\":300,\n \"oldValues\":null,\n \"operationType\":\"fetch\",\n \"startRow\":0,\n \"textMatchStyle\":\"exact\",\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"id\",\n \"operator\":\"equals\",\n \"value\":644\n }\n ]\n }\n}\n```\n

\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_FETCH | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage Workflow Logics (`WF_BUILDER`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listLivePriceGridItemsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1, "description": "Enter `fetch`, null, or omit the param." }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string" } } } } } } } }, "examples": { "listLPGItemsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "equals", "value": "USD" } ] } } } } } } } } }, "/pricegridmanager.copy/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Live Price Grid you want to copy. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Copy a Price Grid", "operationId": "post-pricegridmanager.copy-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "copyPriceGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "label", "numberOfItems", "keepManualOverrides", "writeOnlyChangedItems", "configuration", "numberOfApprovedItems", "numberOfOpenItems", "numberOfDeniedItems", "numberOfSubmittedItems", "numberOfAutoApprovedItems", "priceGridType", "createdByName", "lastUpdateByName", "updatedBy", "updateDate", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "status", "id" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": {}, "label": { "type": "string", "minLength": 1 }, "locale": {}, "calculationMessages": {}, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "nodeId": {}, "approvalState": {}, "description": {}, "relativeTargetDateDays": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "numberOfApprovedItems": { "type": "number" }, "numberOfOpenItems": { "type": "number" }, "numberOfDeniedItems": { "type": "number" }, "numberOfSubmittedItems": { "type": "number" }, "numberOfAutoApprovedItems": { "type": "number" }, "integrationStatus": {}, "priceGridType": { "type": "string", "minLength": 1 }, "headerTypeUniqueName": {}, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": {}, "calculationDate": {}, "partialCalculationDate": {}, "id": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Live Price Grids" ], "description": "Creates a copy of the specified Live Price Grid (including metadata and Price Grid Items).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_ADD | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Administer LPG (`PB_PRICEGRIDS`)\n" } }, "/pricegridmanager.massedit/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Live Price Grid whose items you want to edit. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Mass Edit Price Grid Items", "operationId": "post-pricegridmanager.massedit-id", "responses": { "200": { "description": "OK - The response contains `\"data\":null` as the mass edit task is a background process whose results are not yet available within the response time.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "massEditPriceGridItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } }, "required": [ "node", "status" ] } }, "required": [ "response" ] } } } } }, "description": "Updates fields of specified Live Price Grid Items.

Specify the items in the request body by the `id` field.\n\n> **Information**:\n> The `id` is the `typedId` without the **PGI** suffix. For example, the `id` attribute of the item with `typedId` = **649.PGI** is **649**.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_UPDATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "massEditPriceGridItemsRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "items": { "type": "string" } }, "_constructor": { "type": "string", "minLength": 1 } } } } } }, "massEditRecords": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "The field you want to edit." }, "massEditOperator": { "type": "string", "minLength": 1, "enum": [ "+", "-", "*", "=" ], "example": "=" }, "fieldValue": { "description": "The new value of the field. If omitted, the field is set to null.", "type": "integer" }, "precision": {} } } } } } } }, "examples": { "massEditLPGIRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "649", "650" ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "manualResultPrice", "massEditOperator": "=", "fieldValue": 20, "precision": "2" } ] } } } } } } }, "tags": [ "Live Price Grids" ] } }, "/pricegridmanager.update/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid whose item you want to update. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Update a Live Price Grid Item", "operationId": "post-pricegridmanager.update-id", "responses": { "200": { "$ref": "#/components/responses/pricegriditemResponse" } }, "tags": [ "Live Price Grids" ], "description": "Updates a Price Grid Item.\n\n>To update items without a recalculation, use the **/pricegridmanager.update/{id}/norecalc** endpoint.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_UPDATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateLivePriceGridItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1, "description": "`typedId` of the item you want to update." }, "comments": { "type": "string", "minLength": 1 } } }, "oldValues": { "type": "object", "description": "Values of the object before the update. Especially important is `typedId` (to identify the object to update) and `version` (to detect date inconsistencies).", "properties": { "_key": { "type": "string", "minLength": 1 }, "_level": { "type": "number" }, "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "priceGridId": { "type": "number" }, "manualEditVersion": { "type": "number" }, "manualPriceExpired": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "itemExtensions": { "type": "object" }, "completeResultsAvailable": { "type": "boolean" } }, "required": [ "version", "typedId", "manualEditVersion" ] }, "operationType": { "type": "string", "minLength": 1, "description": "Must be 'update' or null or omitted." }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data" ] }, "examples": { "updatePriceGridItemRequestExample": { "value": { "data": { "typedId": "654.PGI", "comments": "a comment" }, "oldValues": { "_key": "654.PGI", "_level": 0, "version": 0, "typedId": "654.PGI", "sku": "22222", "label": "Label Two", "unitOfMeasure": "EA", "priceGridId": 212, "manualEditVersion": 8, "manualPriceExpired": false, "createDate": "2021-11-08T16:53:21", "createdBy": 2147490696, "itemExtensions": {}, "completeResultsAvailable": false }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "We have performed an update action on the `comments` field in our request sample >>>" } } }, "/pricegridmanager.update/{id}/norecalc": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid whose item you want to update. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Update a Live Price Grid Item (No Recalculation)", "operationId": "post-pricegridmanager.update-id-norecalc", "responses": { "200": { "$ref": "#/components/responses/pricegriditemResponse" } }, "tags": [ "Live Price Grids" ], "description": "Updates a Price Grid Item without recalculation. Use this endpoint to skip recalculation of `comments` and `manualResultPrice` (Manual Override).\n\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_UPDATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateLivePriceGridItemNoRecalcRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1, "description": "`typedId` of the item you want to update." }, "comments": { "type": "string", "minLength": 1 } } }, "oldValues": { "type": "object", "description": "Values of the object before the update. Especially important is `typedId` (to identify the object to update) and `version` (to detect date inconsistencies).", "properties": { "_key": { "type": "string", "minLength": 1 }, "_level": { "type": "number" }, "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "priceGridId": { "type": "number" }, "manualPriceExpired": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "itemExtensions": { "type": "object" }, "completeResultsAvailable": { "type": "boolean" } }, "required": [ "version", "typedId" ] }, "operationType": { "type": "string", "minLength": 1, "description": "Must be 'update' or null or omitted." }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data" ] }, "examples": { "updatePriceGridItemRequestExample": { "value": { "data": { "typedId": "654.PGI", "comments": "a comment" }, "oldValues": { "_key": "654.PGI", "_level": 0, "version": 0, "typedId": "654.PGI", "sku": "22222", "label": "Label Two", "unitOfMeasure": "EA", "priceGridId": 212, "manualPriceExpired": false, "createDate": "2021-11-08T16:53:21", "createdBy": 2147490696, "itemExtensions": {}, "completeResultsAvailable": false }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "We have performed an update action on the `comments` field in our request sample >>>" } } }, "/pricegridmanager.delete/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid you want to delete the Price Grid Item from." } ], "post": { "summary": "Delete a Price Grid Item", "operationId": "post-pricegridmanager.delete-id", "responses": { "200": { "$ref": "#/components/responses/pricegriditemResponse" } }, "description": "Deletes a Live Price Grid Item object from the specified Live Price Grid.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_REMOVE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Administer LPG (`PB_PRICEGRIDS`)", "tags": [ "Live Price Grids" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deletePriceGridItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deletePriceGridItemRequestExample": { "value": { "data": { "typedId": "649.PGI" } } } } } } } } }, "/pricegridmanager.reject/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid that contains the Price Grid Item you want to deny." } ], "post": { "summary": "Deny a Live Price Grid Item", "operationId": "post-pricegridmanager.reject-id", "responses": { "200": { "$ref": "#/components/responses/pricegriditemResponse" } }, "tags": [ "Live Price Grids" ], "description": "Sets the `approvalState` field to `Denied`.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_SUBMIT | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "denyLivePriceGridItemRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "description": "Specify `typedId`s of items you want to deny.", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "denyPriceGridItemRequestExample": { "value": { "data": { "ids": [ "650.PGI" ] } } } } } } } } }, "/pricegridmanager.delete/{id}/batch": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid that contains Price Grid Items you want to delete." } ], "post": { "summary": "Delete a Price Grid Item (Filter)", "operationId": "post-pricegridmanager.delete-id-batch", "responses": { "200": { "description": "OK" } }, "tags": [ "Live Price Grids" ], "description": "Deletes a Live Price Grid Item based on filter settings.\n\n---\n**Filter example**:

\nDeletes only Price Grid Items where `comments` = \"del\".\n```json\n{\n \"data\": {\n \"filterCriteria\": {\n \"operator\": \"and\",\n \"criteria\": [\n {\n \"fieldName\": \"comments\",\n \"operator\": \"iEquals\",\n \"value\": \"del\"\n }\n ]\n }\n }\n}\n```\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_REMOVE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deletePriceGridItemFilterRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "fieldName", "operator", "value" ], "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } }, "required": [ "operator", "criteria" ] } }, "required": [ "filterCriteria" ] } }, "required": [ "data" ] }, "examples": { "deletePriceGridItemRequestExample": { "value": { "data": { "filterCriteria": { "operator": "and", "criteria": [ { "fieldName": "comments", "operator": "iEquals", "value": "del" } ] } } } } } } }, "description": "" } } }, "/pricegridmanager.add/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Live Price Grid where you want to add Price Grid Items to. `id` is the `typedId` without **PG** suffix. For example, the `id` attribute of the item with `typedId` = **649.PG** is **649**. You can retrieve the `id` of the LPG, for example, by calling the `/fetch/PG` endpoint." } ], "post": { "summary": "Add Price Grid Items to a Price Grid", "operationId": "post-pricegridmanager.add-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addPriceGridItemsToPriceGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "description": "Adds products to the Live Price Grid.\n\n> **Information**:\n> Only products that are not already in the Price Grid will be added.\nYou can specify products by `skus` (see the *example 1* below) or by filter settings (see *example 2*).\n\n---\n**Example 1**:

\nAdds only products with specified SKUs.\n```json\n{\n \"data\":{\n \"skus\":[\n \"p0001\",\n \"p0002\"\n ]\n }\n}\n```\n\n**Example 2**:

\nAdds only products where `formulaName` = \"CompetitionPricing\".\n```json\n{\n \"data\":{\n \"filterCriteria\":{\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"formulaName\",\n \"operator\":\"iEquals\",\n \"value\":\"CompetitionPricing\"\n }\n ]\n }\n }\n}\n```\n\n---\n\n>To add items without a recalculation, use the **/pricegridmanager.add/{id}/norecalc** endpoint.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_ADD | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Administer LPG (`PB_PRICEGRIDS`)\n", "tags": [ "Live Price Grids" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addPriceGridItemsRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "fieldName", "operator", "value" ], "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } }, "required": [ "operator", "criteria" ] } }, "required": [ "filterCriteria" ] } }, "required": [ "data" ] }, "examples": { "addPriceGridItemsRequestExample": { "value": { "data": { "filterCriteria": { "operator": "and", "criteria": [ { "fieldName": "formulaName", "operator": "iEquals", "value": "CompetitionPricing" } ] } } } } } } } } } }, "/pricegridmanager.calculate/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "post": { "summary": "Calculate a Price Grid", "operationId": "post-pricegridmanager.calculate-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "calculatePriceGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "status", "trackerType", "targetObject", "jobName", "concurrencyKey", "cancelRequested", "runNumber", "priority", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "id" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "processingNode": {}, "threadId": {}, "threadUUID": {}, "status": { "type": "string", "minLength": 1 }, "trackerType": { "type": "string", "minLength": 1 }, "targetObject": { "type": "string", "minLength": 1 }, "jobName": { "type": "string", "minLength": 1 }, "concurrencyKey": { "type": "string", "minLength": 1 }, "calculationContext": {}, "progress": {}, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "number" }, "priority": { "type": "number" }, "messages": {}, "jobSettings": { "type": "object", "properties": { "distributedAction": {}, "jobType": { "type": "string", "minLength": 1 }, "uuid": { "type": "string", "minLength": 1 }, "calculableObjectTypedId": { "type": "string", "minLength": 1 }, "queueName": {}, "runNumber": { "type": "number" }, "partitionName": { "type": "string", "minLength": 1 }, "partitionUUID": { "type": "string", "minLength": 1 }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "number" }, "distributed": { "type": "boolean" } }, "required": [ "jobType", "uuid", "calculableObjectTypedId", "runNumber", "partitionName", "partitionUUID", "enableDirtyTracking", "agentOption1", "jobSize", "distributed" ] }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "calculationResults": {}, "processingStart": {}, "processingEnd": {}, "id": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "data", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Live Price Grids" ], "description": "Starts a calculation of the entire Live Price Grid.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_CALCULATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)" } }, "/pricegridmanager.cancel/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Live Price Grid whose running calculation should be cancelled." } ], "post": { "summary": "Cancel a Calculation", "operationId": "post-pricegridmanager.cancel-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "cancelCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string" }, "data": {}, "status": { "type": "number" } }, "required": [ "node", "csrfToken", "status" ] } }, "required": [ "response" ] } } } } }, "tags": [ "Live Price Grids" ], "description": "Cancels a Price Grid calculation background job.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_CALCULATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)" } }, "/pricegridmanager.massaction/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price Grid that contains items you want to apply workflow actions to." } ], "post": { "summary": "Perform a Mass Action", "operationId": "post-pricegridmanager.massaction-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "performMassActionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } }, "examples": { "massActionResponseExample": { "value": { "response": { "node": "string", "data": null, "status": 0 } } } } } } } }, "tags": [ "Live Price Grids" ], "description": "Performs a mass workflow action on specified Price Grid Items based on filter settings.\n\n---\n**Example**:

\nApproves only products where `activePrice` = 250.\n```json\n{\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"activePrice\",\n \"operator\":\"equals\",\n \"value\":250\n }\n ],\n \"workflowAction\":\"APPROVED\",\n \"comment\":\"Approved.\"\n }\n}\n```\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_UPDATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "title": "performMassActionRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "_constructor", "operator", "criteria", "comment" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "Specify the criteria for which you want to filter the data.", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "Specify columns (fields) you want to apply the workflow action to." }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "number", "description": "Specify the value of the field." } }, "required": [ "fieldName", "operator", "value" ] } }, "workflowAction": { "type": "string", "minLength": 1, "description": "Specify the workflow action you want to perform.", "example": "APPROVED", "enum": [ "SUBMITTED", "WITHDRAWN", "APPROVED", "DENIED" ] }, "comment": { "type": "string", "minLength": 0, "description": "Enter the comment. Only for **Approve** and **Deny** actions." }, "itemAction": { "type": "string", "description": "Specify the item action you want to perform.", "enum": [ "recalculate", "edit" ] } } } }, "required": [ "data" ] }, "examples": { "massActionRequestExample": { "value": { "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "activePrice", "operator": "equals", "value": 11 } ], "workflowAction": "SUBMITTED", "comment": "" } } } } } } } } }, "/pricegridmanager.massactioncount/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "post": { "summary": "Count Mass Action Items", "operationId": "post-pricegridmanager.massactioncount-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "countMassActionItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "totalRows": { "type": "number", "description": "The number of affected items by the mass action operation." }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Live Price Grids" ], "description": "Returns a number of Price Grid Items that would be affected by the mass action operation.

\n`totalRows` value = number of affected items.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_UPDATE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Edit LPG (`PB_PRICEGRIDEDITOR`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "countMassActionItemsRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "fieldName", "operator", "value" ], "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } }, "workflowAction": { "type": "string", "minLength": 1 } }, "required": [ "_constructor", "operator", "criteria", "workflowAction" ] } }, "required": [ "data" ] }, "examples": { "massActionCountRequestExample": { "value": { "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "iEquals", "value": "USD" } ], "workflowAction": "SUBMITTED" } } } } } } } } }, "/pricegridmanager.convert2pl/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "post": { "summary": "Convert to Price List", "operationId": "post-pricegridmanager.convert2pl-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "convertPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "pricelistId": { "type": "number", "description": "The ID of the created Price List." } } } }, "status": { "type": "number" } } } } }, "examples": { "convert2PLResponseExample": { "value": { "response": { "node": "", "csrfToken": "", "data": [ { "pricelistId": 2147480401 } ], "status": 0 } } } } } } } }, "tags": [ "Live Price Grids" ], "description": "Converts a Live Price Grid (including items) to a Price List. Returns the `pricelistId`.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_ADD | Manage Price Lists (`PB_PRICELISTSEDITOR`), Administer Price Lists (`PB_PRICELISTS`)" } }, "/pricegridmanager.delete": { "post": { "summary": "Delete a Live Price Grid", "operationId": "post-pricegridmanager.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteLivePriceGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "version", "typedId", "label", "calculationMessages", "numberOfItems", "keepManualOverrides", "writeOnlyChangedItems", "configuration", "approvalState", "numberOfApprovedItems", "numberOfOpenItems", "numberOfDeniedItems", "numberOfSubmittedItems", "numberOfAutoApprovedItems", "priceGridType", "createdByName", "lastUpdateByName", "updatedBy", "updateDate", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "status", "calculationStartDate", "calculationDate", "partialCalculationDate", "id" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": {}, "label": { "type": "string", "minLength": 1 }, "locale": {}, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "nodeId": {}, "approvalState": { "type": "string", "minLength": 1 }, "description": {}, "relativeTargetDateDays": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "numberOfApprovedItems": { "type": "number" }, "numberOfOpenItems": { "type": "number" }, "numberOfDeniedItems": { "type": "number" }, "numberOfSubmittedItems": { "type": "number" }, "numberOfAutoApprovedItems": { "type": "number" }, "integrationStatus": {}, "priceGridType": { "type": "string", "minLength": 1 }, "headerTypeUniqueName": {}, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "partialCalculationDate": { "type": "string", "minLength": 1 }, "id": { "type": "number" } } } }, "status": { "type": "number" } }, "required": [ "node", "data", "status" ] } }, "required": [ "response" ] } } } } }, "description": "Deletes the Price Grid specified by `typedId`.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICEGRID_REMOVE | Edit LPG & Add Products (`PB_PRICEGRIDEDITOR_ADD_SKU`), Administer LPG (`PB_PRICEGRIDS`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteLivePriceGridRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deletePriceGridRequestExample": { "value": { "data": { "typedId": "212.PG" } } } } } } }, "tags": [ "Live Price Grids" ] } }, "/fetch/PL": { "post": { "summary": "List Price Lists", "operationId": "post-fetch-PL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listPriceListsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "errorMode": { "type": "string", "minLength": 1 }, "pricelistType": { "type": "string", "minLength": 1 }, "approvalState": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "id": { "type": "number" } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Price Lists" ], "description": "Retrieves a list of Price Lists. You can apply a filter on returned price lists.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listPriceListsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listPriceListsRequestExample": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "createDate", "operator": "greaterThan", "value": "2021-10-01T12:03:52" } ] } } } } } } } } }, "/fetch/PL/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List you want to retrieve details for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "Get a Price List", "operationId": "post-fetch-PL-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "errorMode": { "type": "string", "minLength": 1 }, "pricelistType": { "type": "string", "minLength": 1 }, "approvalState": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "id": { "type": "number" } } } }, "status": { "type": "number" } } } } }, "examples": { "getPriceListResponseExample": { "value": { "response": { "node": "", "csrfToken": "", "data": [ { "version": 0, "typedId": "2147490401.PL", "targetDate": "2021-11-10", "label": "Test PL", "locale": null, "calculationMessages": "[]", "numberOfItems": 6, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"elementNames\":[\"ListPrice\"],\"resultElementName\":\"ListPrice\",\"shotgunModeEnabled\":false,\"defaultFormulaOverride\":\"PriceList\",\"formulaParameters\":{}}", "errorMode": "SKIP", "pricelistType": "SIMPLE", "nodeId": null, "previousPricelistId": null, "expiryDate": null, "approvalState": "NOT_APPROVED", "description": null, "userGroupEdit": null, "userGroupViewDetails": null, "workflowStatus": null, "submittedByName": null, "integrationStatus": null, "createdByName": "admin", "lastUpdateByName": "admin", "jstId": null, "updateDate": "2021-11-10", "updatedBy": 2147490696, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "lastUpdateDate": "2021-11-10T12:38:30", "lastUpdateBy": 2147490696, "status": "READY", "calculationStartDate": null, "calculationDate": "2021-11-09T17:38:47", "approvalDate": null, "submitDate": null, "exportDate": null, "id": 2147490401 } ], "status": 0 } } } } } } } }, "tags": [ "Price Lists" ], "description": "Retrieves Price List details." } }, "/pricelistmanager.fetch/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List you want to retrieve items for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "List Price List Items", "operationId": "post-pricelistmanager.fetch-id", "responses": { "200": { "$ref": "#/components/responses/pricelistitemResponse" } }, "tags": [ "Price Lists" ], "description": "Retrieves a list of Price List Items. A filter can be applied.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_FETCH | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), View Price Lists (`PB_PRICELISTS_RO`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listPriceListItemsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } } } } }, "examples": { "listPriceListItemsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "unitOfMeasure", "operator": "iEquals", "value": "EA" } ] } } } } } } } } }, "/pricelistmanager.add/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List you want to create a revision for. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "Create a Revision", "tags": [ "Price Lists" ], "responses": { "200": { "$ref": "#/components/responses/pricelistitemResponse" } }, "operationId": "post-pricelistmanager.add-id", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createRevisionRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "priceListName", "targetDate", "errorMode" ], "properties": { "priceListName": { "type": "string", "minLength": 1, "description": "Specifies parameter names and values used for formula computation." }, "targetDate": { "type": "string", "minLength": 1, "description": "Set the validity date of the price list." }, "errorMode": { "type": "string", "minLength": 1 }, "keepManualOverrides": { "description": "A flag to indicate if manual overrides should be preserved in the revision." }, "useFilter": { "description": "Specifies whether the original product filter criteria (if still available/applicable) should be used." }, "writeOnlyChangedItems": { "description": "A flag to indicate if only items with price changes should be written to the revision." }, "configuration": { "type": "object", "properties": { "shotgunModeEnabled": { "type": "boolean" }, "notifyWhenFinished": { "type": "string", "minLength": 1 }, "plTypeTypeId": {}, "preferencesSource": { "type": "number" }, "sortKeys": {}, "defaultFormulaOverride": { "type": "string", "minLength": 1 }, "resultElementName": { "type": "string", "minLength": 1 }, "matrixFormulaName": {}, "matrixElementName": {}, "uomOverrideElementName": {}, "currencyOverrideElementName": {}, "elementNames": { "type": "array", "items": { "type": "string" } }, "hiddenElementNames": { "type": "array", "items": { "type": "object" } }, "formulaParameters": { "type": "object" } } }, "override": { "description": "If set to `true`, adds products from products selection criteria to the price list and will override existing results if present. If set to `false`, adds products, but will not override results. If this value is null, then a revision of the entire Price List is triggered." } } } }, "required": [ "data" ] }, "examples": { "createRevisionRequestExample": { "value": { "data": { "priceListName": "PriceList01", "targetDate": "2021-11-10T14:46:08.508Z", "errorMode": "SKIP", "keepManualOverrides": true, "useFilter": true, "writeOnlyChangedItems": true, "configuration": { "shotgunModeEnabled": false, "notifyWhenFinished": "EMAIL", "plTypeTypeId": null, "preferencesSource": 2147490401, "sortKeys": null, "defaultFormulaOverride": "PriceList", "resultElementName": "ListPrice", "matrixFormulaName": null, "matrixElementName": null, "uomOverrideElementName": null, "currencyOverrideElementName": null, "elementNames": [ "ListPrice" ], "hiddenElementNames": [], "formulaParameters": {} }, "override": null } } } } } } }, "description": "Creates a revision of the Price List.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_ADD | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)" } }, "/pricelistmanager.calculate/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List you want to calculate. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "Calculate a Pricelist", "tags": [ "Price Lists" ], "operationId": "post-pricelistmanager.calculate-id", "description": "Calculates the Price List specified by `id` in the path parameter.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_UPDATE | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "title": "calculatePricelistRequest", "properties": { "fullListRecalc": { "type": "boolean", "default": false, "description": "Calculates a whole price list. If true then `fullCalculationDateTime` is set. If false or not set and `idsToRecalc` are specified, then the `partialCalculationDateTime` is set." } } } } }, "examples": {} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "calculatePricelistResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "calculatePricelistResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-85cd8bf896-9x45v", "data": [ { "version": 0, "typedId": "2148043261.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "PRICELIST", "targetObject": "2147490405.PL", "jobName": "Price List 2021", "concurrencyKey": "2147490405.PL", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "PL", "uuid": "fcWJk", "calculableObjectTypedId": "2147490405.PL", "queueName": "fcWJk", "runNumber": 0, "partitionName": "companypartition", "partitionUUID": "6562656564", "enableDirtyTracking": true, "agentOption1": true, "jobSize": 3, "distributed": false }, "createDate": "2023-06-01T12:54:44", "createdBy": 2147490696, "lastUpdateDate": "2023-06-01T12:54:44", "lastUpdateBy": 2147490696, "parameters": "{\"fullListRecalc\":true}", "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148043261 } ], "status": 0 } } } } } } } } } }, "/pricelistmanager.update/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List whose Item you want to update. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "Update a Pricelist Detail", "tags": [ "Price Lists" ], "operationId": "post-pricelistmanager.update-id", "description": "Updates the Price List Item (PLI) of the Pricelist specified by `id` in the path parameter.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_UPDATE | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updatePricelistDetailResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PricelistItem" } }, "status": { "type": "integer" } } } } }, "examples": { "updatePricelistDetailResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5fcf48565-lz98n", "data": [ { "version": 2, "typedId": "2147563142.PLI", "label": "The Label24", "comments": "a comment", "workStatus": null, "alerts": null, "warnings": "{\"MarginPct\":[\"WTF?! Margin!\"],\"ListPrice\":[\"WTF?!\"],\"CompetitivePositioning\":[\"Product attribute BusinessUnit not found\",\"VLookup table CompetitionStrategy not found\"]}", "allowedOverrides": "", "manualOverrides": null, "sku": "123456789", "unitOfMeasure": "EA", "currency": "USD", "resultPrice": null, "previousPrice": null, "priceChange": null, "priceChangePct": null, "manualResultPrice": null, "calculatedResultPrice": null, "targetDate": "2021-11-10T00:00:00", "listLabel": "Test Pricelist", "pricelistId": 2147490401, "updatedBy": 2147490696, "key2": null, "updateDate": "2023-06-02", "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "lastUpdateDate": "2023-06-02T10:11:23", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "approvalState": 0, "itemExtensions": {}, "completeResultsAvailable": true } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updatePricelistDetailRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" }, "comments": { "type": "string" }, "manualResultPrice": { "type": "string" } } }, "oldValues": { "$ref": "#/components/schemas/PricelistItem" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "data", "oldValues" ] } } } } } }, "/pricelistmanager.add": { "parameters": [], "post": { "summary": "Create a Price List", "tags": [ "Price Lists" ], "operationId": "post-pricelistmanager.add", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "priceListName", "targetDate", "errorMode" ], "properties": { "priceListName": { "type": "string", "minLength": 1, "description": "Specifies parameter names and values used for formula computation." }, "targetDate": { "type": "string", "minLength": 1, "description": "Set the validity date of the price list." }, "errorMode": { "type": "string", "minLength": 1 }, "keepManualOverrides": { "description": "A flag to indicate if manual overrides should be preserved in the revision." }, "useFilter": { "description": "Specifies whether the original product filter criteria (if still available/applicable) should be used." }, "writeOnlyChangedItems": { "description": "A flag to indicate if only items with price changes should be written to the revision." }, "configuration": { "type": "object", "properties": { "shotgunModeEnabled": { "type": "boolean" }, "notifyWhenFinished": { "type": "string", "minLength": 1 }, "plTypeTypeId": {}, "preferencesSource": { "type": "number" }, "sortKeys": {}, "defaultFormulaOverride": { "type": "string", "minLength": 1 }, "resultElementName": { "type": "string", "minLength": 1 }, "matrixFormulaName": {}, "matrixElementName": {}, "uomOverrideElementName": {}, "currencyOverrideElementName": {}, "elementNames": { "type": "array", "items": { "type": "string" } }, "hiddenElementNames": { "type": "array", "items": { "type": "object" } }, "formulaParameters": { "type": "object" } } }, "override": { "description": "If set to `true`, adds products from products selection criteria to the price list and will override existing results if present. If set to `false`, adds products, but will not override results. If this value is null, then a revision of the entire Price List is triggered." } } } }, "required": [ "data" ] }, "examples": { "createPriceListRequestExample": { "value": { "data": { "priceListName": "Price List 2021", "targetDate": "2021-11-10", "errorMode": "ABORT", "keepManualOverrides": null, "useFilter": null, "writeOnlyChangedItems": null, "configuration": { "shotgunModeEnabled": false, "notifyWhenFinished": "NONE", "productFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "inSet", "value": [ "11111", "22222", "33333" ] } ] }, "sortKeys": null, "resultElementName": "ListPrice", "matrixFormulaName": null, "matrixElementName": null, "uomOverrideElementName": null, "elementNames": [ "BasePrice" ], "hiddenElementNames": [] }, "override": null, "nodeId": null } } } } } } }, "description": "Creates a new Price List.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_ADD | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "createPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "locale": { "type": "string", "minLength": 1 }, "calculationMessages": {}, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "errorMode": { "type": "string", "minLength": 1 }, "pricelistType": { "type": "string", "minLength": 1 }, "nodeId": {}, "previousPricelistId": {}, "expiryDate": {}, "approvalState": { "type": "string", "minLength": 1 }, "description": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "workflowStatus": {}, "submittedByName": {}, "integrationStatus": {}, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "jstId": { "type": "number" }, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachments": {}, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": {}, "calculationDate": {}, "approvalDate": {}, "submitDate": {}, "exportDate": {}, "id": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } } } }, "/pricelistmanager.submit/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Price List you want to submit. The `id` is the `typedId` without the suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." } ], "post": { "summary": "Submit a Price List", "operationId": "post-pricelistmanager.submit-id", "responses": { "200": { "$ref": "#/components/responses/pricelistitemResponse" } }, "tags": [ "Price Lists" ], "description": "Starts an approval process for the Price List.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_UPDATE | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actionComment": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "submitPricelistRequestExample": { "value": { "data": { "actionComment": "a comment" } } } } } } } } }, "/pricelistmanager.revoke/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true } ], "post": { "summary": "Revoke a Price List", "operationId": "post-pricelistmanager.revoke-id", "responses": { "200": { "$ref": "#/components/responses/pricelistitemResponse" } }, "tags": [ "Price Lists" ], "description": "Revokes an approved Price List.\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_REVOKE | Administer Price Lists (`PB_PRICELISTS`)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "actionComment": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "revokePricelistRequestExample": { "value": { "data": { "actionComment": "a comment" } } } } } } } } }, "/pricelistmanager.delete/PL/{id}/batch": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "Enter the ID of the Price List where you want to delete an item from." } ], "post": { "summary": "Delete a Price List Item", "operationId": "post-pricelistmanager.delete-PL-id-batch", "responses": { "200": { "description": "OK - Returns a number of deleted items.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deletePriceListItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string" }, "data": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" } } } } }, "examples": { "deletePriceListItemResponseExample": { "value": { "response": { "node": "node", "csrfToken": "token", "data": [ "1" ], "status": 0 } } } } } } } }, "tags": [ "Price Lists" ], "description": "Deletes a Price List Item based on filter settings.\n\n---\n**Filter example**:

\nDeletes only Price List Items where `comments` = \"denied\".\n```json\n{\n \"data\": {\n \"filterCriteria\": {\n \"operator\": \"and\",\n \"criteria\": [\n {\n \"fieldName\": \"comments\",\n \"operator\": \"iEquals\",\n \"value\": \"denied\"\n }\n ]\n }\n }\n}\n```\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_REMOVE | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deletePriceListItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "fieldName", "operator", "value" ], "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } }, "required": [ "operator", "criteria" ] } }, "required": [ "filterCriteria" ] } }, "required": [ "data" ] }, "examples": { "deletePriceListItemRequestExample": { "value": { "data": { "filterCriteria": { "operator": "and", "criteria": [ { "fieldName": "comments", "operator": "iEquals", "value": "denied" } ] } } } } } } } } } }, "/pricelistmanager.delete": { "post": { "summary": "Delete a Price List", "operationId": "post-pricelistmanager.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deletePriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "locale": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "errorMode": { "type": "string", "minLength": 1 }, "pricelistType": { "type": "string", "minLength": 1 }, "nodeId": {}, "previousPricelistId": { "type": "number" }, "expiryDate": {}, "approvalState": { "type": "string", "minLength": 1 }, "description": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "workflowStatus": {}, "submittedByName": {}, "integrationStatus": {}, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "jstId": {}, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachments": {}, "updatedBy": { "type": "number" }, "updateDate": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "approvalDate": {}, "submitDate": { "type": "string", "minLength": 1 }, "exportDate": {}, "id": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Price Lists" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deletePriceListRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deletePriceListRequestExample": { "value": { "data": { "typedId": "2147490403.PL" } } } } } } }, "description": "Deletes a Price List specified by `typedId`.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICELIST_REMOVE | Administer Price Lists (`PB_PRICELISTS`), Manage Price Lists (`PB_PRICELISTSEDITOR`)" } }, "/formulamanager.fetch/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic you want to retrieve details for." } ], "post": { "summary": "Get a Logic", "operationId": "post-formulamanager.fetch-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaNature": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "elements": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "elementName": { "type": "string", "minLength": 1 }, "elementLabel": { "type": "string", "minLength": 1 }, "elementDescription": {}, "elementGroups": { "type": "array", "items": { "type": "object" } }, "conditionElementName": {}, "hideWarnings": { "type": "boolean" }, "excludeFromExport": { "type": "boolean" }, "protectedExpression": { "type": "boolean" }, "elementTimeout": { "type": "number" }, "displayOptions": { "type": "number" }, "formatType": {}, "elementSuffix": {}, "allowOverride": { "type": "boolean" }, "summarize": { "type": "boolean" }, "hideOnNull": { "type": "boolean" }, "userGroup": {}, "cssProperties": {}, "resultGroup": {}, "combinationType": { "type": "string", "minLength": 1 }, "storeInAttributeExtension": { "type": "boolean" }, "criticalAlert": {}, "redAlert": {}, "yellowAlert": {}, "labelTranslations": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "formulaExpression": { "type": "string", "minLength": 1 } }, "required": [ "version", "typedId", "elementName", "elementLabel", "hideWarnings", "excludeFromExport", "protectedExpression", "elementTimeout", "displayOptions", "allowOverride", "summarize", "hideOnNull", "combinationType", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "formulaExpression" ] } }, "inputDescriptors": { "type": "array", "items": { "type": "object" } }, "formulaType": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "", "csrfToken": "", "data": [ { "version": 1, "typedId": "2147484839.F", "uniqueName": "QuoteLogic", "label": "QuoteLogic", "validAfter": "2021-07-13", "status": "ACTIVE", "simulationSet": null, "userGroupEdit": null, "userGroupViewDetails": null, "formulaNature": null, "lastUpdateByName": "admin", "elements": [ { "version": 1, "typedId": "2147494046.FE", "elementName": "DeclareInputParameters", "elementLabel": "DeclareInputParameters", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 0, "formatType": null, "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if(api.isSyntaxCheck()){\r\n api.integerUserEntry(\"Quantity\")\r\n def quantityParam = api.getParameter(\"Quantity\")\r\n quantityParam.setLabel(\"Required Quantity\")\r\n quantityParam.setRequired(true)\r\n\r\n quantityParam.setConfigParameter(\"inputType\", \"range\")\r\n quantityParam.setConfigParameter(\"from\", 1)\r\n\r\n api.userEntry(\"SalesDiscountPct\")\r\n def discountParam = api.getParameter(\"SalesDiscountPct\")\r\n discountParam.setLabel(\"Sales Discount (%)\")\r\n discountParam.setRequired(false)\r\n discountParam.setValue(0)\r\n discountParam.setConfigParameter(\"formatType\", \"PERCENT\")\r\n\r\n discountParam.setConfigParameter(\"inputType\", \"range\")\r\n discountParam.setConfigParameter(\"from\", 0)\r\n discountParam.setConfigParameter(\"to\", 1)\r\n\r\n\r\n api.abortCalculation()\r\n}" }, { "version": 1, "typedId": "2147494047.FE", "elementName": "Quantity", "elementLabel": "Quantity", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "INTEGER", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "return input.Quantity" }, { "version": 1, "typedId": "2147494048.FE", "elementName": "SalesDiscountPct", "elementLabel": "Sales Discount %", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 2, "formatType": "PERCENT", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "return input.SalesDiscountPct?:0.0" }, { "version": 1, "typedId": "2147494049.FE", "elementName": "ListPrice", "elementLabel": "List Price", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 16, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "return api.pricelist(\"GlobalPriceList\")" }, { "version": 1, "typedId": "2147494050.FE", "elementName": "SalesDiscountAbs", "elementLabel": "Sales Discount EUR", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if (out.ListPrice == null ||\r\nout.SalesDiscountPct == null) {\r\n api.addWarning(\"Sales Discount cannot be calculated: missing parameter(s)\")\r\n return null\r\n}\r\n\r\nreturn out.ListPrice * out.SalesDiscountPct" }, { "version": 1, "typedId": "2147494051.FE", "elementName": "FreightSurcharge", "elementLabel": "Freight Surcharge", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 2, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if(api.isDebugMode()) {\r\n input.Customer = \"CD-00004\"\r\n input.DeliveryType = \"Standard\"\r\n}\r\n\r\ndef country = api.customer(\"Country\", input.Customer)\r\n\r\ndef keys = [\r\n \"Country\": country,\r\n \"DeliveryType\": input.DeliveryType\r\n]\r\n\r\nreturn api.vLookup(\"FreightSurcharge\", \"FreightSurcharge\", keys)" }, { "version": 1, "typedId": "2147494052.FE", "elementName": "InvoicePrice", "elementLabel": "Invoice Price", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if (out.ListPrice == null ||\r\nout.SalesDiscountAbs == null) {\r\n api.addWarning(\"InvoicePrice cannot be calculated: missing parameter(s)\")\r\n return null\r\n}\r\n\r\nreturn out.ListPrice - out.SalesDiscountAbs" }, { "version": 1, "typedId": "2147494053.FE", "elementName": "TotalInvoicePrice", "elementLabel": "Total Invoice Price", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if (out.InvoicePrice == null\r\n || out.Quantity == null\r\n || out.FreightSurcharge == null) {\r\n api.addWarning(\"Total Invoice Price cannot be calculated: missing parameter(s)\")\r\n return null\r\n}\r\n\r\nreturn out.InvoicePrice * out.Quantity + out.FreightSurcharge" }, { "version": 1, "typedId": "2147494054.FE", "elementName": "Cost", "elementLabel": "Cost", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "return cost = (api.productExtension(\"ProductCost\")?:null)?.first()?.attribute1" }, { "version": 1, "typedId": "2147494055.FE", "elementName": "PocketMarginAbs", "elementLabel": "Pocket Margin EUR", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if (out.InvoicePrice == null\r\n || out.Cost == null) {\r\n api.addWarning(\"Pocket Margin cannot be calculated: missing parameter(s)\")\r\n return null\r\n}\r\n\r\nreturn out.InvoicePrice - out.Cost" }, { "version": 1, "typedId": "2147494056.FE", "elementName": "PocketMarginPct", "elementLabel": "Pocket Margin %", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 18, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:13", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696, "formulaExpression": "if (out.PocketMarginAbs == null\r\n || out.ListPrice == null) {\r\n api.addWarning(\"Pocket Margin % cannot be calculated: missing parameter(s)\")\r\n return null\r\n}\r\n\r\nif (out.ListPrice == 0) {\r\n api.addWarning(\"List Price is 0, which means that Pocket Margin cannot be \" +\r\n \"calculated, since this would lead to division by 0\")\r\n return null\r\n}\r\n\r\n\r\ndef pocketMarginPct = out.PocketMarginAbs / out.ListPrice\r\n\r\nString productGroup = api.product(\"ProductGroup\")\r\nString thresholdTableName = \"PocketMarginAlertThreshold\"\r\ndef yellowThreshold = api.vLookup(thresholdTableName, \"Threshold\", productGroup, \"Yellow\")\r\ndef redThreshold = api.vLookup(thresholdTableName, \"Threshold\", productGroup, \"Red\")\r\ndef criticalThreshold = api.vLookup(thresholdTableName, \"Threshold\", productGroup, \"Critical\")\r\n\r\nif (criticalThreshold && pocketMarginPct < criticalThreshold) {\r\n api.criticalAlert(\"Pocket Margin % is unacceptable low\")\r\n}\r\nelse if (redThreshold && pocketMarginPct < redThreshold){\r\n api.redAlert(\"Pocket Margin % is very low\")\r\n}\r\nelse if (yellowThreshold && pocketMarginPct < yellowThreshold) {\r\n api.yellowAlert(\"Pocket Margin % is low\")\r\n}\r\n\r\nreturn pocketMarginPct" } ], "inputDescriptors": [], "formulaType": "PRICING", "createdByName": null, "createDate": "2021-11-04T14:56:12", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T14:56:13", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Logics" ], "description": "Returns full details of the logic, including all sub-elements.\n\n> **Information**:\n> The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the logic with `typedId` = **2147484823.F** is **2147484823**.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n PRICINGFORMULA_FETCH | Administer Policy Records (`PO_MODELRECORDS_ADMIN`), Manage PA Calculation Logics (`PA_FORMULAS`), Manage Contracts Calculation Logics (`CM_FORMULAS`), Manage Rebate Agreement Templates (`RM_RAT`), Administer PriceOptimizer (`PO_MANAGER`), Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage PromotionManager (`CM_CONTRACTMANAGER`), Administer RebateManager (`RM_REBATEMANAGER`), Administer QuoteConfigurator (`PRICESHOP_QUOTEADMIN`), Manage Calculation Logics (`PB_FORMULAS`), Manage Claims (`CLM_CLAIMMANAGER`), Manage Rebate Calculation Logics (`RM_FORMULAS`)" } }, "/accountmanager.fetchusers": { "post": { "summary": "List Users", "operationId": "post-accountmanager.fetchusers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listUsersResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "loginName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "minLength": 1 }, "activated": { "type": "boolean" }, "workflowEmailingActivated": { "type": "boolean" }, "noSession": { "type": "boolean" }, "requireTFA": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "ssoOnly": { "type": "boolean" }, "firstLogin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastLogin": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "description": "Retrieves a list of users.\n\n>**Information**:\n>If the authenticated user does not have the explicit `USER_FETCH` permission, the fields are reduced to a minimum.", "tags": [ "User Admin" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listUsersRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "boolean" } } } } } } } }, "examples": { "listUsersRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "workflowEmailingActivated", "operator": "notEqual", "value": true } ] } } } } } } } } }, "/datamart.getfcs/DM": {}, "/fetch/RBA": { "post": { "summary": "List Rebate Agreements", "tags": [ "Rebate Agreements" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listRebateAgreementsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "numberOfAttachments": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "payoutDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "rebateAgreementStatus": { "type": "string", "minLength": 1 }, "approvedByName": { "type": "string", "minLength": 1 }, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "rootUniqueName": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "operationId": "post-fetch-RBA", "description": "Retrieves a list of rebate agreements.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n REBATEAGREEMENT_FETCH | Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Administer RebateManager (`RM_REBATEMANAGER`), Administer Rebate Agreements (`RM_REBATEAGREEMENTS_ADMIN`), Manage Rebate Agreements (`RM_REBATEAGREEMENTS`), View Rebate Agreements (`RM_REBATEAGREEMENTS_RO`)", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listRebateAgreementsRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } }, "sortBy": { "type": "array", "items": { "type": "string" } } } }, "examples": { "listRebateAgreementsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "createdByName", "operator": "equals", "value": "admin" } ] }, "sortBy": [ "createDate" ] } } } } } } } }, "/productmanager.bomtree/{sku}": { "parameters": [ { "schema": { "type": "string" }, "name": "sku", "in": "path", "required": true, "description": "The `sku` of the product you want to retrieve the Bill of Materials for." } ], "post": { "summary": "List BoM for a Product", "operationId": "post-productmanager.bomtree-sku", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listBoMForProductResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "id": { "type": "number" }, "parentId": { "type": "number" }, "level": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "quantity": { "type": "number" }, "totalQuantity": { "type": "number" }, "category": {}, "type": { "type": "string", "minLength": 1 }, "isNode": { "type": "boolean" }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "component": { "type": "boolean" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Products" ], "description": "Retrieves all Bill of Materials for the specified product." } }, "/workflowdelegationmanager.add": { "post": { "summary": "Create a Workflow Delegation", "operationId": "post-workflowdelegationmanager.add", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "createWorkflowDelegationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "sourceUserId": { "type": "number" }, "sourceUser": { "type": "string", "minLength": 1 }, "targetUserId": { "type": "number" }, "targetUser": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 }, "createdByAdmin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow Delegation" ], "description": "Adds a new delegation record. Allows you to assign approval rights to another user and set the time period in which the delegation should be active.\n\n\n> Use the `/workflowdelegationmanager.checkdates` (**Validate a Workflow Delegation**) endpoint to ensure that all provided dates are valid and there are no conflicts.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createWorkflowDelegationRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "startDate", "endDate", "sourceUserId", "targetUserId" ], "properties": { "sourceUser": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The name of the user whose workflow you want to delegate." }, "targetUser": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The name of the user you want to delegate a workflow to." }, "startDate": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The date from which the workflow delegation should come into effect." }, "endDate": { "type": "string", "minLength": 1, "description": "The date until which the workflow delegation should be effective." }, "note": { "type": "string", "minLength": 1, "maxLength": 255, "description": "A comment for the workflow delegation." }, "sourceUserId": { "type": "string", "minLength": 1, "description": "The ID of the user whose workflow you want to delegate." }, "targetUserId": { "type": "string", "minLength": 1, "description": "The ID of the user you want to delegate a workflow to." } } } }, "required": [ "data" ] }, "examples": { "delegateWorkflowRequestExample": { "value": { "data": { "sourceUser": "John Doe", "targetUser": "Kate Smith", "startDate": "2021-11-23T08:19:13.941Z", "endDate": "2021-11-23T08:19:21.940Z", "note": "Please, check all new quotes. I'm on vacation.", "sourceUserId": "2147490806", "targetUserId": "2147490696" } } } } } } } } }, "/workflowdelegationmanager.fetch": { "post": { "summary": "List Delegated Workflows", "operationId": "post-workflowdelegationmanager.fetch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listDelegatedWorkflowsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "sourceUserId": { "type": "number" }, "sourceUser": { "type": "string", "minLength": 1 }, "targetUserId": { "type": "number" }, "targetUser": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 }, "createdByAdmin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow Delegation" ], "description": "Retrieves a list of workflow delegations. A filter can be applied to return **Initialized**, **Activated**, or **EndDated** workflow delegations only. See the example below.

\n**The Filter Example**:\nReturns only active delegations (`status` = `ACTIVATED`.)\n```json\n{\n \"data\":{\n \"_constructor\":\"AdvancedCriteria\",\n \"operator\":\"and\",\n \"criteria\":[\n {\n \"fieldName\":\"status\",\n \"operator\":\"equals\",\n \"value\":\"ACTIVATED\"\n }\n ]\n }\n}\n```", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listDelegatedWorkflowsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listDelegatedWorkflowsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "equals", "value": "ENDDATED" } ] } } } } } } } } }, "/workflowdelegationmanager.checkdates": { "post": { "summary": "Validate a Workflow Delegation", "operationId": "post-workflowdelegationmanager.checkdates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "validateWorkflowDelegationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow Delegation" ], "description": "Checks delegation for conflicts. Always use this operation before `/workflowdelegationmanager.add` to prevent invalid date conflicts in the new delegation.\nUse the same payload as for the `/workflowdelegationmanager.add` operation.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "validateWorkflowDelegationRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "startDate", "endDate", "sourceUserId", "targetUserId" ], "properties": { "sourceUser": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The name of the user whose workflow you want to delegate." }, "targetUser": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The name of the user you want to delegate a workflow to." }, "startDate": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The date from which the workflow delegation should come into effect." }, "endDate": { "type": "string", "minLength": 1, "description": "The date until which the workflow delegation should be effective." }, "note": { "type": "string", "minLength": 1, "maxLength": 255, "description": "A comment for the workflow delegation." }, "sourceUserId": { "type": "string", "minLength": 1, "description": "The ID of the user whose workflow you want to delegate." }, "targetUserId": { "type": "string", "minLength": 1, "description": "The ID of the user you want to delegate a workflow to." } } } }, "required": [ "data" ] }, "examples": { "validateNewDelegationRequestExample": { "value": { "data": { "sourceUser": "John Doe", "targetUser": "Kate Smith", "startDate": "2021-11-23T08:19:13.941Z", "endDate": "2021-11-23T08:19:21.940Z", "note": "Please, check all new quotes. I'm on vacation.", "sourceUserId": "2147490806", "targetUserId": "2147490696" } } } } } } } } }, "/workflowdelegationmanager.delete": { "post": { "summary": "Delete a Workflow Delegation", "operationId": "post-workflowdelegationmanager.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteWorkflowDelegationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "sourceUserId": { "type": "number" }, "sourceUser": { "type": "string", "minLength": 1 }, "targetUserId": { "type": "number" }, "targetUser": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 }, "createdByAdmin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Workflow Delegation" ], "description": "Deletes a delegation and returns the deleted delegation details.\n\n>A delegation where `status` = `ACTIVATED` cannot be deleted. Only delegations that have not been activated yet (`startDate` is in the future) can be deleted. Use the **/workflowdelegationmanager.enddate** endpoint to terminate an activated workflow delegation.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteWorkflowDelegationRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "minLength": 1, "description": "The `typedId` of the delegation you want to delete.", "maxLength": 255, "example": "99.WD" } } } }, "required": [ "data" ] }, "examples": { "deleteDelegationRequestExample": { "value": { "data": { "typedId": "12.WD" } } } } } } } } }, "/workflowdelegationmanager.update": { "post": { "summary": "Update a Workflow Delegation", "operationId": "post-workflowdelegationmanager.update", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "updateWorkflowDelegationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "sourceUserId": { "type": "number" }, "sourceUser": { "type": "string", "minLength": 1 }, "targetUserId": { "type": "number" }, "targetUser": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 }, "createdByAdmin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "description": "Allows you to update a workflow delegation's note. Returns updated delegation details.", "tags": [ "Workflow Delegation" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateWorkflowDelegationRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "updateWorkflowDelegation": { "value": { "data": { "typedId": "12.WD", "note": "Please, check approvals. I'm on vacation until Thursday." } } } } } } } } }, "/workflowdelegationmanager.enddate": { "post": { "summary": "Deactivate a Workflow Delegation", "operationId": "post-workflowdelegationmanager.enddate", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deactivateWorkflowDelegationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "sourceUserId": { "type": "number" }, "sourceUser": { "type": "string", "minLength": 1 }, "targetUserId": { "type": "number" }, "targetUser": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "note": { "type": "string", "minLength": 1 }, "createdByAdmin": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } }, "required": [ "response" ] } } } } }, "tags": [ "Workflow Delegation" ], "description": "Terminates an activated workflow delegation. Returns details of the terminated workflow delegation.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deactivateWorkflowDelegationRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "enddateWorkflowDelegationRequestExample": { "value": { "data": { "typedId": "99.WD" } } } } } } } } }, "/customermanager.fetchformulafilteredcustomers": { "post": { "summary": "List Customers", "operationId": "post-customermanager.fetchformulafilteredcustomers", "responses": { "200": { "$ref": "#/components/responses/customerResponse" } }, "tags": [ "Customers" ], "description": "Retrieves a list of Customers. A filter can be applied (see the request sample).

\n\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the **listCustomersResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the **listCustomersResponseExample_valueFields** response example.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listCustomersRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "nullable": true, "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listCustomersRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "attribute2", "operator": "iEquals", "value": "123456789" } ] } } }, "listCustomersRequestExample_resultFields": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": null, "resultFields": [ "customerId", "attribute1" ] } }, "listCustomersRequestExample_valueFields": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": null, "valueFields": [ "customerId", "attribute1" ] } } } } } } } }, "/fetch/CT": { "post": { "summary": "List Contracts", "operationId": "post-fetch-CT", "responses": { "200": { "$ref": "#/components/responses/contractResponse" } }, "tags": [ "Contracts (Agreements & Promotions)" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listContractsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listContractsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "userGroupViewDetails", "operator": "notEqual", "value": "trash" }, { "fieldName": "workflowStatus", "operator": "equals", "value": "APPROVED" } ] }, "sortBy": [ "-createDate" ] } } } } } }, "description": "Returns a list of Agreements and Promotions (formerly *Contracts*)." } }, "/rebateagreement.save": { "post": { "summary": "Upsert a Rebate Agreement", "operationId": "post-rebateagreement.save", "responses": { "200": { "$ref": "#/components/responses/rebateagreementResponse" } }, "tags": [ "Rebate Agreements" ], "description": "Creates or updates a Rebate Agreement. Assigns new `uniqueName` when a new Rebate Agreement is created. To update a Rebate Agreement, specify an existing `uniqueName`.\n>This endpoint is not allowed to modify the document status and workflow status.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertRebateAgreementRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "rebateAgreement": { "type": "object", "properties": { "version": {}, "typedId": {}, "uniqueName": {}, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string" }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": { "type": "object", "properties": { "customerFieldName": { "type": "string", "minLength": 1 }, "customerFieldValue": { "type": "string", "minLength": 1 }, "customerFieldLabel": { "type": "string", "minLength": 1 }, "customerHint": { "type": "string", "minLength": 1 } } }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": {}, "createdByName": {}, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": { "type": "string" } }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "seller": {}, "customerGroup": {}, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "payoutDate": { "type": "string", "minLength": 1 }, "rebateRecordSetId": {}, "rebateRecordSetLabel": {}, "simulationSet": {}, "simulationType": {}, "status": { "type": "string", "minLength": 1 }, "approvedByName": {}, "deniedByName": {}, "renderInfo": {}, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "key": {}, "message": { "type": "string", "minLength": 1 } } } }, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": {}, "headerRebateType": {}, "sellerName": {} } } } } } }, "examples": { "upsertRebateAgreementRequestExample": { "value": { "data": { "rebateAgreement": { "version": null, "typedId": null, "uniqueName": null, "label": "RBA001", "targetDate": "2021-11-26", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": { "customerFieldName": "customerId", "customerFieldValue": "00003", "customerFieldLabel": "customerId", "customerHint": "Kate Smith" }, "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": { "productFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "or", "criteria": [ { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "11111" } ] }, { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "22222" } ] }, { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "33333" } ] } ] }, "label": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333" }, "valueHint": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": null, "createdByName": null, "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Rebates calculated successfully" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "seller": null, "customerGroup": null, "startDate": "2021-11-26", "endDate": "2021-11-26", "payoutDate": "2021-11-26", "rebateRecordSetId": null, "rebateRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "approvedByName": null, "deniedByName": null, "renderInfo": null, "serverMessagesExtended": [ { "key": null, "message": "Rebates calculated successfully" } ], "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2021-11-26T13:42:10", "createdBy": 2147490696, "lastUpdateDate": "2021-11-26T13:42:10", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": null, "headerRebateType": null, "sellerName": null } } } } } } } } } }, "/rebateagreement.fetchitems": { "post": { "summary": "List Rebate Agreement Items", "operationId": "post-rebateagreement.fetchitems", "tags": [ "Rebate Agreements" ], "description": "Retrieves Rebate Agreement Items. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listRebateAgreementItemsRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "oldValues": {}, "distinctResults": { "type": "boolean" }, "data": { "type": "object", "properties": { "rebateAgreement": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "headerText": {}, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "nodeId": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 } } }, "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "items": { "type": "object" } } } } } }, "endRow": { "type": "number" }, "sortBy": { "type": "array", "items": { "type": "object" } } } }, "examples": { "listRebateAgreementItems": { "value": { "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "oldValues": null, "distinctResults": false, "data": { "rebateAgreement": { "label": "New Rebate Agreement", "headerText": null, "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "outputs": [], "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "lineItems": [], "startDate": "2021-10-19", "endDate": "2021-10-19" }, "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [] } }, "endRow": 300, "sortBy": [] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listRebateAgreementItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaName": { "type": "string", "minLength": 1 }, "waterfallElement": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } } } }, "/accountmanager.changepassword/{userId}": { "post": { "summary": "Change a User Password", "operationId": "post-accountmanager.changepassword-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "changeUserPasswordResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Changes a specified user's password.

The authenticated user needs the `ADMIN` (including `USERADMIN`) permissions to perform this action. To change your own password, use the **/accountmanager.changepassword** endpoint instead.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "changeUserPasswordRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "newPassword": { "type": "string", "minLength": 1 } }, "required": [ "newPassword" ] } }, "required": [ "data" ] }, "examples": { "changeUserPasswordRequestExample": { "value": { "data": { "newPassword": "eqweqweqwQW112131FF*" } } } } } } } }, "parameters": [ { "schema": { "type": "string", "example": "2147490806" }, "name": "userId", "in": "path", "required": true, "description": "Enter the ID of the user whose password you want to change. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ] }, "/accountmanager.changepassword": { "post": { "summary": "Change a Current User Password", "operationId": "post-accountmanager.changepassword", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "changeCurrentUserPasswordResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Changes an authenticated user's password.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "changeCurrentUserPasswordRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "newPassword", "oldPassword" ], "properties": { "newPassword": { "type": "string", "minLength": 1, "description": "The new password.", "maxLength": 255 }, "oldPassword": { "type": "string", "description": "The current password. Necessary when changing own password.", "maxLength": 255, "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "changeUserPasswordRequestExample": { "value": { "data": { "newPassword": "eqweqweqwQW112131FF*", "oldPassword": "12345678pwdd9876543" } } } } } } } }, "parameters": [] }, "/accountmanager.assigngroup/{userId}": { "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to add to the group. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ], "post": { "summary": "Assign a User to a User Group", "operationId": "post-accountmanager.assigngroup-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignUserToUserGroupResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "description": "Assigns a User Group to the specified user.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignUserToUserGroupRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to add the user to the User Group. Set `false` to remove the user from the group." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the User Group you want to assign or revoke. Either `typedId` or `uniqeName` is required." }, "uniqueName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "`uniqeName` of the User Group you want to assign or revoke. Either `typedId` or `uniqeName` is required." } } } }, "required": [ "data" ] }, "examples": { "addUsertoUserGroupRequestExample": { "value": { "data": { "assign": true, "uniqueName": "PricingManagers", "typedId": "15666.UG" } } } } } } }, "tags": [ "User Admin" ] } }, "/accountmanager.fetchgroups/{userId}": { "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to retrieve groups for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ], "post": { "summary": "List User's User Groups", "operationId": "post-accountmanager.fetchgroups-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listUsersUserGroupsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Returns a list of user group objects that are assigned to the specified user." } }, "/accountmanager.fetchroles/{userId}": { "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to retrieve roles for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ], "post": { "summary": "List User's Roles", "operationId": "post-accountmanager.fetchroles-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listUserRolesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Returns a list of role objects that are assigned to the specified user.

\n**Avaialble for the following roles**:\n- `ADMIN` (*General Admin*)\n- `USERADMIN` (*Administer Users*)\n- `SUPPORT` (*Investigate for Support*)\n- `USERAUDIT` (*View Audits and Users*)\n- `PLASMA` (*Adminster Plasma*)" } }, "/accountmanager.fetchbusinessroles/{userId}": { "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to retrieve business roles for. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ], "post": { "summary": "List User's Business Roles", "operationId": "post-accountmanager.fetchbusinessroles-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listUserBusinessRolesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Returns a list of business role objects that are assigned to the specified user." } }, "/accountmanager.fetchroles/BR/{businessroleId}": { "parameters": [ { "schema": { "type": "string" }, "name": "businessroleId", "in": "path", "required": true, "description": "The ID of the business role you want to retrieve user roles for. The `businessroleId` is the `typedId` without the `BR` suffix. For example, `businessroleId` of the **53.BR** is **53**." } ], "post": { "summary": "List Roles of the Business Role", "operationId": "post-accountmanager.fetchroles-BR-businessroleId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listRolesOfBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "module": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": {}, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": {} } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Returns all user roles that the specified business role is assigned to." } }, "/accountmanager.fetchgroups/BR/{businessroleId}": { "parameters": [ { "schema": { "type": "string" }, "name": "businessroleId", "in": "path", "required": true, "description": "The ID of the business role you want to retrieve user roles for. The `businessroleId` is the `typedId` without the `BR` suffix. For example, `businessroleId` of the **53.BR** is **53**." } ], "post": { "summary": "List Groups of the Business Role", "operationId": "post-accountmanager.fetchgroups-BR-businessroleId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listGroupsOfBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "module": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": {}, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": {} } } }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Returns all user groups that the specified business role is assigned to." } }, "/accountmanager.deletebusinessrole": { "post": { "summary": "Delete a Business Role", "operationId": "post-accountmanager.deletebusinessrole", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "roles": { "type": "array", "items": { "type": "object" } }, "groups": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Deletes a Business Role. The general datasource */delete* operation (*/delete/BR*) should NOT be used for Business Role object as this special command (**/accountmanager.deletebusinessrole**) also performs a cleanup of related objects (objects that have this business role assigned).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteBusinessRoleRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "minLength": 1, "example": "99.BR", "description": "The `typedId` of the business role object you want to delete." } } } }, "required": [ "data" ] }, "examples": { "deleteBusinessRoleRequestExample": { "value": { "data": { "typedId": "53.BR" } } } } } } } } }, "/accountmanager.copyroles": { "post": { "summary": "Copy Roles", "operationId": "post-accountmanager.copyroles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "copyRolesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "copyRolesRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "minLength": 1, "description": "The `typedId` of the source user." }, "to": { "type": "array", "description": "The `typedId`s of target users.", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "copyrolesReqiestExample": { "value": { "data": { "from": "2147490696.U", "to": [ "2147490806.U" ] } } } } } }, "description": "" }, "description": "Copies roles from the existing user to other users." } }, "/accountmanager.getjsonwebtoken": { "post": { "summary": "Generate a JWT Token", "operationId": "post-accountmanager.getjsonwebtoken", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "generateJWTTokenResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin", "Authentication" ], "description": "Generates and returns a non-expiring JSON Web Token for the authenticated user. Allows to restrict the scope of the token by a list of permissions. Used for integration purposes.\n\n>**Information**:\n>The request header must contain real credentials (i.e. not just a session cookie).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "generateJWTTokenRequest", "properties": { "data": { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } } } } } }, "examples": { "generateJWTTokenRequestExample": { "value": { "data": { "permissions": [ "CUSTOMER_ADD", "CUSTOMER_FETCH" ] } } } } } } } } }, "/accountmanager.getjsonwebtoken/{minutes}": { "post": { "summary": "Generate a JWT Token (time limited)", "operationId": "post-accountmanager.getjsonwebtoken-minutes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "generateJWTTokenTimeLimitedResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin", "Authentication" ], "description": "Generates and returns an expiring JSON Web Token for the authenticated user. Used for integration purposes.\n\n\n>**Information**:\n>The request header must contain real credentials (i.e. not just a session cookie)." }, "parameters": [ { "schema": { "type": "string" }, "name": "minutes", "in": "path", "required": true, "description": "The number of minutes in which the token expires." } ] }, "/accountmanager.assignrole": { "post": { "summary": "Assign a Role to Users", "operationId": "post-accountmanager.assignrole", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignRoleToUsersResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a role to multiple users.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignRoleToUsersRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName", "users" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the user to the role. Set `false` to remove the role from the user." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "8.R" }, "uniqueName": { "type": "string", "minLength": 1, "description": "`uniqueName` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "DASHBOARDADMIN" }, "users": { "type": "array", "description": "The list of users' `typedId`s or `loginName`. Can be mixed.", "items": { "type": "string", "example": "2147491023.U" } } } } }, "required": [ "data" ] }, "examples": { "assignRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "8.R", "uniqueName": "DASHBOARDADMIN", "users": [ "2147491023.U", "john.doe" ] } } } } } } } } }, "/accountmanager.assigngroup": { "post": { "summary": "Assign a User Group to Users", "operationId": "post-accountmanager.assigngroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignUserGroupToUsersResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a group to multiple users.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignUserGroupToUsersRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName", "users" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the group to the user. Set `false` to remove the group from the user." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the group you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "15666.UG" }, "uniqueName": { "type": "string", "minLength": 1, "description": "`uniqueName` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "Administrators" }, "users": { "type": "array", "description": "The list of users' `typedId`s or `loginName`. Can be mixed.", "items": { "type": "string", "example": "2147491023.U" } } } } }, "required": [ "data" ] }, "examples": { "assignRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "8.R", "uniqueName": "DASHBOARDADMIN", "users": [ "2147491023.U", "john.doe" ] } } } } } } } }, "parameters": [] }, "/accountmanager.assignrole/{userId}": { "post": { "summary": "Assign a Role to a User", "operationId": "post-accountmanager.assignrole-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignRoleToUserResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a role to a user.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignRoleToUserRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the user to the role. Set `false` to remove the role from the user." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "8.R" }, "uniqueName": { "type": "string", "minLength": 1, "description": "`uniqueName` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "DASHBOARDADMIN" } } } }, "required": [ "data" ] }, "examples": { "assignRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "8.R", "uniqueName": "DASHBOARDADMIN", "users": [ "2147491023.U", "john.doe" ] } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to assign a role to. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ] }, "/accountmanager.assignbusinessrole/{userId}": { "post": { "summary": "Assign a Business Role to a User", "operationId": "post-accountmanager.assignbusinessrole-userId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignBusinessRoleToUserResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a business role to a user.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignBusinessRoleToUserRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the business role to the user. Set `false` to remove the business role from the user." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the business role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "8.R" }, "uniqueName": { "type": "string", "minLength": 1, "description": "`uniqueName` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "DASHBOARDADMIN" } } } }, "required": [ "data" ] }, "examples": { "assignRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "8.R", "uniqueName": "DASHBOARDADMIN", "users": [ "2147491023.U", "john.doe" ] } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "userId", "in": "path", "required": true, "description": "The ID of the user you want to assign a role to. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ] }, "/accountmanager.assignbusinessrole": { "post": { "summary": "Assign a Business Role", "operationId": "post-accountmanager.assignbusinessrole", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a business role to multiple users.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignBusinessRoleRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId", "uniqueName", "users" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the user to the business role. Set `false` to remove the business role from the user." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the business role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "8.R" }, "uniqueName": { "type": "string", "minLength": 1, "description": "`uniqueName` of the business role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "DASHBOARDADMIN" }, "users": { "type": "array", "description": "The list of users' `typedId`s or `loginName`. Can be mixed.", "items": { "type": "string", "example": "2147491023.U" } } } } }, "required": [ "data" ] }, "examples": { "assignRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "8.R", "uniqueName": "DASHBOARDADMIN", "users": [ "2147491023.U", "john.doe" ] } } } } } } } }, "parameters": [] }, "/accountmanager.deletegroup": { "post": { "summary": "Delete a User Group", "operationId": "post-accountmanager.deletegroup", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteUserGroupResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Deletes a User Group. The general datasource /delete operation should NOT be used for the User Group object as this special command (**/accountmanager.deletegroup**) also performs a cleanup of related objects (objects that have this business role assigned).", "requestBody": { "content": { "application/json": { "schema": { "title": "deleteUserGroupRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "description": "`data` must contain the `typedId` of the user group object you want to delete or all business key fields of that object type.'", "properties": { "typedId": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "deleteUserGroupRequestExample": { "value": { "data": { "typedId": "15667.UG" } } } } } } } } }, "/accountmanager.copyuser/{userid}": { "parameters": [ { "schema": { "type": "string" }, "name": "userid", "in": "path", "required": true, "description": "The ID of the user you want to copy. The `userId` is the `typedId` without the `U` suffix. For example, `userId` of the **2147490806.U** is **2147490806**." } ], "post": { "summary": "Copy a User", "operationId": "post-accountmanager.copyuser-userid", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "copyUserResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "loginName": { "type": "string", "minLength": 1 }, "firstName": {}, "lastName": {}, "email": {}, "groups": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "businessRoles": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "roles": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "module": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": {}, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": {} } } }, "groups": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "activated": { "type": "boolean" }, "workflowEmailingActivated": { "type": "boolean" }, "noSession": { "type": "boolean" }, "requireTFA": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "ssoOnly": { "type": "boolean" }, "wizardDashboardName": {}, "firstLogin": { "type": "boolean" }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "emailLocale": {}, "defaultUserGroupEdit": {}, "defaultUserGroupViewDetails": {}, "productFilterCriteria": {}, "customerFilterCriteria": {}, "allRoleNames": { "type": "array", "items": { "type": "object" } }, "allGroups": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "roleNames": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastLogin": {}, "lastUpdateBy": { "type": "number" }, "extendedData": {}, "passwordExpiry": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Creates a copy of a selected user (including role and user group assignments). First name, last name, email and password are NOT copied (as they typically are different anyway)." } }, "/accountmanager.assignrole/BR/businessroleId": { "post": { "summary": "Assign a Role to a Business Role", "operationId": "post-accountmanager.assignrole-BR-businessroleId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignRoleToBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a role to a business role.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignRoleToBusinessRoleRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the role to the business role. Set `false` to remove the role from the business role." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the role you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "2147483672.R" } } } }, "required": [ "data" ] }, "examples": { "addRoletoBusinessRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "2147483672.R" } } } } } } } } }, "/accountmanager.assigngroup/BR/businessroleId": { "post": { "summary": "Assign a Group to a Business Role", "operationId": "post-accountmanager.assigngroup-BR-businessroleId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "assignGroupToBusinessRoleResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin" ], "description": "Assigns a group to a business role.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignGroupToBusinessRoleRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "assign", "typedId" ], "properties": { "assign": { "type": "boolean", "description": "Set to `true` to assign the group to the business role. Set `false` to remove the group from the business role." }, "typedId": { "type": "string", "minLength": 1, "description": "`TypedId` of the group you want to assign or revoke. Either `typedId` or `uniqeName` is required.", "example": "2147483672.R" } } } }, "required": [ "data" ] }, "examples": { "addRoletoBusinessRoleRequestExample": { "value": { "data": { "assign": true, "typedId": "2147483672.R" } } } } } } } }, "parameters": [] }, "/accountmanager.getonetimetoken": { "post": { "summary": "Get a One Time Token", "operationId": "post-accountmanager.getonetimetoken", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getOneTimeTokenResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "User Admin", "Authentication" ], "description": "Generates a one time auth token (for the authenticated user). The token can be, for example, sent via a URL GET parameter." } }, "/datamart.getfcs/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "DM", "DMDS", "DMF", "DMT" ], "example": "DM" }, "name": "TypeCode", "in": "path", "description": "The type code of the **Field Collection**.", "required": true } ], "post": { "summary": "List Data Manager Entities", "operationId": "post-datamart.getfcs-TypeCode", "responses": { "200": { "$ref": "#/components/responses/dmobjectResponse" } }, "tags": [ "Data Manager" ], "description": "Retrieves Data Manager Entities (Field Collections), including object's metadata. A filter can be applied.\n\nAction| Endpoint|\n---------|----------|\n**List Data Feeds** | */datamart.getfcs/DMF*\n**List Data Sources** | */datamart.getfcs/DMDS*\n**List Datamarts** | */datamart.getfcs/DM*\n**List Datamart Model Tables** | */datamart.getfcs/DMT*\n**List Data Loads** | Use a different endpoint to retrieve Data Loads: */datamart.getdataloads*", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listDataManagerEntitiesRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "Specify a name of the field of the DM entity." }, "operator": { "type": "string", "minLength": 1, "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ], "description": "Specify an operator of the filter criteria." }, "value": { "type": "string", "minLength": 1, "description": "" } } } } } } } }, "examples": { "listDMEntitiesRequestExample": { "value": { "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "lastUpdateBy", "operator": "equals", "value": "2147490696" } ] } } } } } } } } }, "/datamart.distcalcparams/{typedId}/{logicName}": { "parameters": [ { "schema": { "type": "string", "example": "2147483780.DMDL" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Data Load you want to evaluate." }, { "schema": { "type": "string", "example": "E2ETestsLogic" }, "name": "logicName", "in": "path", "required": true, "description": "The name of the logic you want to execute." } ], "post": { "summary": "Execute a Data Load Logic", "operationId": "post-datamart.distcalcparams-typedId-formulaName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeDataLoadLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "contextParameters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "properties": { "dataType": { "type": "string", "minLength": 1 } } }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } } } } } } } } } } } } }, "description": "Executes the logic in the DMDataLoad context and returns the parameter definitions or test results.", "tags": [ "Data Manager" ] } }, "/datamart.fetch/{objectId}": { "parameters": [ { "schema": { "type": "string", "example": "123456.DMDS || DMDS.Transactions || DM.TxDM || *" }, "name": "objectId", "in": "path", "required": true, "description": "Use one of the following object identifiers:\n - **typedUniquename** – Format: \"*\\.\\*\" (e.g., DMDS.SalesTransactions)\n - **typedId** – Format: \"*\\.\\*\" (e.g., 123456.DMDS)'\n - **\"*\"** (asterisk) – Asterisk can be used when you are providing a **source$query** in `data` within the request body\n" } ], "post": { "summary": "Get a DM Object", "operationId": "post-datamart.fetch-objectId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getDMObjectResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object" } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "string", "startRow": 0, "data": [ {} ], "endRow": 0, "totalRows": 0, "status": 0 } } } } } } } }, "description": "Retrieves the object's (Data Feed, Data Source, Datamart) row level data. A filter can be applied.

\nIf you want to achieve better performance when fetching large data sets and if you do not need the total number of items in the table – use the **/datamart.fetchnocount/{typedId}** endpoint instead.

\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Product](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)'s **listProductsResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Product](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)'s **listProductsResponseExample_valueFields** response example.

\n>When `distinctResults` is set to true, it applies only to the first column specified in the `valueFields` array. For example, if `\"valueFields\": [\"ConditionType\", \"TableNumber\"]` is used, only distinct values for `ConditionType` are returned.\n\n

\n\n>**Please note**:\n>When paging is applied, use a deterministic sort (for example, `\"sortBy\":[\"InvoiceLineID\"]`). If no sorting is defined when paging, you may get duplicates in the response.\n", "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "title": "getDMObjectRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } }, "sortBy": { "type": "array", "items": { "type": "string" } }, "resultFields": { "type": "array", "description": "The list of fields you want to return.", "items": { "type": "string" } }, "valueFields": { "type": "array", "items": {} }, "distinctResults": { "type": "boolean", "description": "set to `true` to return only unique values." } } }, "examples": { "getDMObjectRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "iEquals", "value": "EUR" } ] }, "sortBy": [ "InvoiceLineID" ], "resultFields": [ "ProductID", "label", "unitOfMeasure", "currency", "formulaName", "lastUpdateDate" ] } }, "distinctValues": { "value": { "resultFields": [ "ConditionType", "TableNumber" ], "data": { "operator": "and", "criteria": [ { "operator": "equals", "fieldName": "UUID", "value": "adoWhFmzK7EfeNv" } ] }, "distinctResults": true, "valueFields": [ "ConditionType", "TableNumber" ] } } } } } }, "parameters": [ { "$ref": "#/components/parameters/timeout" } ] }, "get": { "summary": "Get a DM Object", "operationId": "get-datamart.fetch-objectId", "responses": { "200": { "description": "Exported data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "Country": { "type": "string" }, "Fertility": { "type": "number" }, "Life_Expectancy": { "type": "number" }, "Population": { "type": "integer" }, "Region": { "type": "string" }, "Year": { "type": "string" }, "ID_Country_Year": { "type": "string" }, "lastUpdateDate": { "type": "string" }, "formulaResult": { "type": "string" }, "formulaDetailedResults": { "type": "string", "nullable": true }, "warnings": { "type": "string" }, "alerts": { "type": "string" }, "completeResultsAvailable": { "type": "boolean" }, "Percent": { "type": "number" }, "Test": { "type": "integer" } } } }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "data": [ { "Country": "Afghanistan", "Fertility": 7.7, "Life_Expectancy": 26.7, "Population": 8151455, "Region": "Asia + Pacific", "Year": "1950", "ID_Country_Year": "Afghanistan_1950", "lastUpdateDate": "2026-01-07T09:41:44", "formulaResult": "OK", "formulaDetailedResults": null, "warnings": "{}", "alerts": "{}", "completeResultsAvailable": false, "Percent": 0.1, "Test": 1008 }, { "Country": "Afghanistan", "Fertility": 7.7, "Life_Expectancy": 26.9, "Population": 8276820, "Region": "Asia + Pacific", "Year": "1951", "ID_Country_Year": "Afghanistan_1951", "lastUpdateDate": "2026-01-07T09:41:44", "formulaResult": "OK", "formulaDetailedResults": null, "warnings": "{}", "alerts": "{}", "completeResultsAvailable": false, "Percent": 0.1, "Test": 1095 } ], "endRow": 2 } } } } } } } }, "description": "Streams the content of a Data Manager object (e.g. Datamart, Data Source export) as a file. GET variant of the existing POST `/datamart.fetch/{objectId}`.", "tags": [ "Data Manager" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "output", "description": "Output format." }, { "schema": { "type": "boolean" }, "in": "query", "name": "stream", "description": "If true, stream the response." }, { "schema": { "type": "string" }, "in": "query", "name": "dataLocale", "description": "Optional locale for formatted output (e.g. en, de)." }, { "schema": { "type": "string" }, "in": "query", "name": "typedUniquename", "description": "Use the following format: (e.g., `DM.TransactionsDM`)" } ] } }, "/datamart.fetchnocount/{objectId}": { "parameters": [ { "schema": { "type": "string" }, "name": "objectId", "in": "path", "required": true, "description": "Use one of the following object identifiers:\n - **typedUniquename** – Format: \"*\\.\\*\" (e.g., DMDS.SalesTransactions)\n - **typedId** – Format: \"*\\.\\*\" (e.g., 123456.DMDS)\n - **\"*\"** (asterisk) – Asterisk can be used when you are providing a **source$query** in `data` within the request body\n" } ], "post": { "summary": "Get a DM Object (no count)", "operationId": "post-datamart.fetchnocount-objectId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getDMObjectNoCountResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object" } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "string", "csrfToken": "string", "startRow": 0, "data": [ {} ], "endRow": 0, "totalRows": 0, "status": 0 } } } } } } } }, "description": "Retrieves the object's (Data Feed, Data Source, Datamart) row level data and skips the **count()** query - it does not return a total number of rows in the entire table when the filter is applied, it returns just the total number of rows in the response.

\n\n>**Information**:\n>Use this endpoint when you need a better performance when fetching large data sets and when you do not need to fetch a total number of items in the table. Usually used **for integration purposes**.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "getDMObjectNoCountRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "getObjectRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "attribute4", "operator": "iEquals", "value": "EUR" } ] } } } } } } }, "tags": [ "Data Manager" ] } }, "/datamart.updatefc/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "DMF", "DM", "DMDS" ], "example": "DM" }, "name": "TypeCode", "in": "path", "required": true, "description": "The type code of the **Field Collection** you want to update." } ], "post": { "summary": "Update a Data Manager Entity", "operationId": "post-datamart.updatefc-TypeCode", "responses": { "200": { "$ref": "#/components/responses/dmobjectResponse" } }, "description": "Updates and deploys a field collection (FC) definition - Data Feed (`DMF`), Datamart (`DM`), or Data Source (`DMDS`).\n\n\n>**Information**:\n>If Data Source (DMDS) is added or updated, then a Data Feed (DMF) is created for the corresponding Data Source.", "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateDataManagerEntityRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "data": { "type": "object", "required": [ "typedId", "uniqueName", "fields" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "sourceFile": {}, "fields": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "labelTranslations": { "type": "object" }, "rank": { "type": "number" }, "format": {}, "measureType": {}, "functionalType": {}, "visibility": { "type": "number" }, "defaultValue": {}, "sourceField": {}, "expression": { "type": "string", "minLength": 1 }, "function": {}, "formulaElement": {}, "messages": {}, "key": { "type": "boolean" }, "system": { "type": "boolean" }, "numeric": { "type": "boolean" }, "deleted": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "calculated": { "type": "boolean" }, "dbColumn": { "type": "string", "minLength": 1 }, "aggregation": { "type": "boolean" }, "time": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "deployed": { "type": "boolean" }, "dbTable": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "source": { "type": "string", "minLength": 1 }, "owningFC": { "type": "string", "minLength": 1 }, "hidden": { "type": "boolean" } } } }, "keyFields": { "type": "array", "items": { "type": "string" } }, "formulaName": {}, "reload": { "type": "boolean" }, "messages": {}, "reservedWords": {}, "rowCount": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "defaultDataSourceName": { "type": "string", "minLength": 1 }, "lineSeperator": {}, "fieldSeperator": {}, "quoteChar": {}, "fetchVerb": { "type": "string", "minLength": 1 }, "integrateVerb": {}, "bulkloadVerb": { "type": "string", "minLength": 1 }, "identikitCriteria": {}, "draft": { "type": "boolean" }, "queryable": { "type": "boolean" }, "view": { "type": "boolean" }, "sourceName": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "valid": { "type": "boolean" }, "status": {}, "targetDate": {}, "calculationMessages": {}, "loadableFields": { "type": "array", "items": { "type": "string" } }, "auxiliary": { "type": "boolean" }, "deployed": { "type": "boolean", "description": "Set to `true` if the matching tables were created/updated." }, "dbTable": { "type": "string", "minLength": 1 }, "dbKey": { "type": "string" }, "dbView": {}, "locked": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "query": {}, "lastDataModificationDate": { "type": "string", "minLength": 1 }, "typeCode": {}, "isPlasma": { "type": "boolean" }, "calculationStartDate": {}, "calculationDate": {} } } } }, "examples": { "updateDataManagerEntityRequestExample": { "value": { "operationType": "update", "data": { "version": 4, "typedId": "2147483684.DMF", "uniqueName": "Meatball_transaction", "label": "Meatball_transaction", "sourceFile": null, "fields": [ { "name": "attribute1", "label": "InvoiceDate", "labelTranslations": {}, "rank": 1, "format": null, "measureType": null, "functionalType": null, "visibility": 1, "defaultValue": null, "sourceField": null, "expression": "attribute1", "function": null, "formulaElement": null, "messages": null, "key": false, "system": false, "numeric": false, "deleted": false, "persisted": true, "dimension": false, "calculated": false, "dbColumn": "attribute1", "aggregation": false, "time": false, "partitioningKey": false, "queryable": true, "auxiliary": false, "deployed": true, "dbTable": "seeddata_DMF_Meatball_transaction", "type": "TEXT", "source": "DMF.Meatball_transaction", "owningFC": "Meatball_transaction", "hidden": false }, { "name": "completeResultsAvailable", "label": "Details", "labelTranslations": {}, "rank": 36, "format": null, "measureType": null, "functionalType": null, "visibility": 0, "defaultValue": null, "sourceField": null, "expression": "NOT ISNULL(formulaDetailedResults)", "function": null, "formulaElement": null, "messages": null, "key": false, "system": true, "numeric": false, "deleted": false, "persisted": false, "dimension": false, "calculated": true, "dbColumn": "attribute1", "aggregation": false, "time": false, "partitioningKey": false, "queryable": true, "auxiliary": true, "deployed": false, "dbTable": "seeddata_DMF_Meatball_transaction", "type": "BOOLEAN", "source": "DMF.Meatball_transaction", "owningFC": "[System]", "hidden": true } ], "keyFields": [], "formulaName": null, "reload": false, "messages": null, "reservedWords": null, "rowCount": null, "lastUpdateByName": "ondrej.tesar", "defaultDataSourceName": "DMDS.Meatball_transaction", "lineSeperator": null, "fieldSeperator": null, "quoteChar": null, "fetchVerb": "datamart.fetch/2147483684.DMF", "integrateVerb": null, "bulkloadVerb": "datamart.loaddata/Meatball_transaction", "identikitCriteria": null, "draft": false, "queryable": true, "view": false, "sourceName": "DMF.Meatball_transaction", "type": "FEED", "valid": true, "status": null, "targetDate": null, "calculationMessages": null, "loadableFields": [ "attribute1", "attribute2", "attribute3", "attribute4", "attribute5", "attribute6", "attribute7", "attribute8", "attribute9", "attribute10", "attribute11", "attribute12", "attribute13", "attribute14", "attribute15", "attribute16", "attribute17", "attribute18", "attribute19", "attribute20", "attribute21", "attribute22", "attribute23", "attribute24", "attribute25", "attribute26", "attribute27" ], "auxiliary": false, "deployed": true, "dbTable": "seeddata_DMF_Meatball_transaction", "dbKey": "", "dbView": null, "locked": false, "createDate": "2018-10-04T17:09:00", "createdBy": 2147483649, "lastUpdateDate": "2021-12-03T13:34:00", "lastUpdateBy": 2147490187, "query": null, "lastDataModificationDate": "2021-12-02T00:09:03", "typeCode": null, "isPlasma": false, "calculationStartDate": null, "calculationDate": null } } } } } }, "description": "Either `uniqueName` or `typedId` must be provided in the request." } } }, "/datamart.newfc/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "DMF", "DM", "DMDS" ], "example": "DM" }, "name": "TypeCode", "in": "path", "required": true, "description": "The type code of the **Field Collection** you want to update." } ], "post": { "summary": "Create a Data Manager Entity", "operationId": "post-datamart.newfc-TypeCode", "responses": { "200": { "$ref": "#/components/responses/dmobjectResponse" } }, "description": "Creates a field collection (FC) definition - Data Feed (`DMF`), Datamart (`DM`), or Data Source (`DMDS`).\n", "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createDataManagerEntityRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "uniqueName", "label" ], "properties": { "uniqueName": { "type": "string", "minLength": 1, "description": "The name of the field collection. Special characters are not allowed, except the underscore (\"_\")." }, "label": { "type": "string", "minLength": 1, "description": "The label for the new Datamart, Data Source, or Data Feed." }, "persistedObjectClass": { "type": "string", "minLength": 1, "description": "Fully qualified name of the domain class whose persisted objects the Data Source is based on." }, "sourceLabel": { "type": "string", "minLength": 1, "description": "Label of the source master object or template from which the Data Source was created." }, "sourceTypeCode": { "type": "string", "minLength": 1, "description": "Short type code identifying the kind of master object the Data Source is based on." } } } }, "required": [ "data" ] }, "examples": { "createDataManagerEntityRequestExample": { "value": { "data": { "uniqueName": "DataSource01", "label": "Data Source 1" } } } } } }, "description": "Either `uniqueName` or `typedId` must be provided in the request." } } }, "/datamart.loaddata/{datasourceUniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "datasourceUniqueName", "in": "path", "required": true, "description": "The unique name of the Data Source where you want to upload the data to. You can also use `typedId` or the source name." } ], "post": { "summary": "Upload a Bulk Data to Data Source", "operationId": "post-datamart.loaddata-datasourceUniqueName", "tags": [ "Data Manager" ], "description": "Uploads a chunk (batch) of data from a client resource to the storage reserved for a particular Data Source.

\nThe uploaded data is not immediately transfered to the Data Source database table. Instead it is held (‘buffered’) in a staging area, until an explicit **flush** command is issued (refer to the **/datamart.rundataload** endpoint, `\"type\": \"DS_FLUSH\"`), or a Datamart dependent on the Data Source data is refreshed.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "uploadBulkDataToDataSourceRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "header", "data" ], "properties": { "header": { "type": "array", "description": "Specify header field names (table columns) of the record in the target Data Source.", "items": { "type": "string" } }, "options": { "type": "object", "description": "Specify options of the bulk data insertion.", "properties": { "detectJoinFields": { "type": "boolean" } } }, "data": { "type": "array", "description": "The data as a list of lists, with the inner lists representing rows, its field values appearing in the same order as specified in the `header` list.", "items": { "type": "array", "items": {} } } } } }, "required": [ "data" ] }, "examples": { "uploadBulkDatatoDataSourceRequestExample": { "value": { "data": { "header": [ "sku", "label", "attribute1", "attribute2" ], "options": { "detectJoinFields": true }, "data": [ [ "11111", "Label One", "EA", "USD" ], [ "22222", "Label Two", "EA", "EUR" ], [ "33333", "Label Three", "EA", "CZK" ] ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "loaded": { "type": "integer" }, "failed": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "uploadBulkDatatoDataSourceResponseExample": { "value": { "response": { "node": "string", "data": [ { "loaded": 3, "failed": 0 } ], "status": 0 } } } } } } } } } }, "/datamart.rundataload": { "post": { "summary": "Run a Data Load", "operationId": "post-datamart.rundataload", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "runDataLoadResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": {}, "label": { "type": "string", "minLength": 1 }, "locale": {}, "type": { "type": "string", "minLength": 1 }, "targetName": { "type": "string", "minLength": 1 }, "sourceName": { "type": "string", "minLength": 1 }, "loadMode": {}, "sortBy": {}, "sourceSortBy": {}, "dtoFilter": {}, "dtoSourceFilter": {}, "withTargetSnapshot": { "type": "boolean" }, "calculationContext": {}, "allowBatching": {}, "validationLogic": {}, "calcItemsLookupTableId": {}, "schedules": {}, "jstId": { "type": "number" }, "progressInfo": {}, "numberOfItems": { "type": "number" }, "actionUUID": {}, "testRow": {}, "testResult": {}, "resultTableUniqueName": {}, "pre80CalculationConfig": {}, "calculationConfig": { "type": "object", "properties": { "skuField": {}, "targetDateField": {}, "simulationSet": {}, "formulaName": {}, "targetDate": {}, "feederFormulaName": {}, "feederInputParams": { "type": "array", "items": { "type": "object" } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object" } }, "targetFields": {} } }, "requestTime": { "type": "number" }, "lastUpdateTime": { "type": "number" }, "loadCompleteTime": {}, "adhocDataLoadDefinition": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": {}, "calculationDate": {}, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "distributed": { "type": "boolean" }, "continuous": { "type": "boolean" }, "valid": { "type": "boolean" }, "isPlasma": { "type": "boolean" }, "incLoadDate": {} }, "required": [ "label", "jstId", "numberOfItems" ] } }, "status": { "type": "number" } } } } } } } } }, "description": "Schedules a Data Load for immediate (but asynchronous) execution.", "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "runDataLoadRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1, "description": "Use the `typedId` to run calculations. For other types (flush, refresh or truncate), use `targetName` (and `sourceName`)." }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1, "example": "DS_FLUSH", "enum": [ "CALCULATION", "DM_REFRESH", "DM_SIMULATION", "DS_CUSTOMERS", "DS_DEFAULTCA", "DS_FLUSH", "DS_PRODUCTSL", "TRUNCATE" ], "description": "The Data Load Type." }, "targetName": { "type": "string", "minLength": 1, "description": "Use the `typedId` to run calculations. For other types (flush, refresh or truncate), use `targetName` (and `sourceName`).", "example": "DMDS.Product" }, "sourceName": { "type": "string", "minLength": 1, "example": "DMF.Product" }, "withTargetSnapshot": { "type": "boolean" }, "schedules": { "type": "array", "items": { "type": "object" } }, "numberOfItems": { "type": "number" }, "calculationConfig": { "type": "object", "properties": { "feederInputParams": { "type": "array", "items": { "type": "object" } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object" } } } }, "requestTime": { "type": "number" }, "lastUpdateTime": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "distributed": { "type": "boolean" }, "continuous": { "type": "boolean" }, "valid": { "type": "boolean" }, "isPlasma": { "type": "boolean" } }, "required": [ "typedId", "targetName", "sourceName" ] } } }, "examples": { "runDataLoadRequestExample": { "value": { "data": { "version": 0, "typedId": "2147483666.DMDL", "label": "Product", "type": "DS_FLUSH", "targetName": "DMDS.Product", "sourceName": "DMF.Product", "withTargetSnapshot": false, "schedules": [], "numberOfItems": 0, "calculationConfig": { "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "requestTime": 1488985402000, "lastUpdateTime": 1488985402000, "createDate": "2017-03-08T15:03:22", "createdBy": 2147483649, "lastUpdateDate": "2017-03-08T15:03:22", "lastUpdateBy": 2147483649, "status": "DRAFT", "isDefault": true, "incremental": true, "distributed": false, "continuous": false, "valid": true, "isPlasma": false, "incLoadDate": "2021-12-09T11:08:01.600Z" } } } } } } } } }, "/datamart.updatedataload": { "post": { "summary": "Save a Data Load", "operationId": "post-datamart.updatedataload", "description": "Updates an existing Data Load.", "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "targetName": { "type": "string" }, "withTargetSnapshot": { "type": "boolean" }, "calcItemsLookupTableId": { "type": "integer" }, "schedules": { "type": "array", "items": { "type": "object", "properties": {} } }, "numberOfItems": { "type": "integer" }, "calculationConfig": { "type": "object", "properties": { "feederInputParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "inputParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "mappingParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "requestTime": { "type": "integer" }, "lastUpdateTime": { "type": "integer" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string" }, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "distributed": { "type": "boolean" }, "continuous": { "type": "boolean" }, "valid": { "type": "boolean" }, "isPlasma": { "type": "boolean" } } } } }, "examples": { "saveDataLoadRequestExample": { "value": { "data": { "version": 2, "typedId": "2147484683.DMDL", "label": "DL01", "type": "DS_PRODUCTS", "targetName": "DMDS.DS001", "withTargetSnapshot": false, "calcItemsLookupTableId": 2147484066, "schedules": [], "numberOfItems": 0, "calculationConfig": { "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "requestTime": 1638456932000, "lastUpdateTime": 1638456932000, "createDate": "2021-12-02T14:55:32", "createdBy": 2147490696, "lastUpdateDate": "2021-12-02T14:55:32", "lastUpdateBy": 2147490696, "status": "DRAFT", "isDefault": false, "incremental": true, "distributed": false, "continuous": false, "valid": false, "isPlasma": false } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DMDataLoad" } }, "status": { "type": "integer" } } } } }, "examples": { "saveDataLoadResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-f465f654b-wjkpv", "data": [ { "version": 2, "typedId": "2147484683.DMDL", "targetDate": null, "label": "DL01", "locale": null, "type": "DS_PRODUCTS", "targetName": "DMDS.DS001", "sourceName": null, "loadMode": null, "sortBy": null, "sourceSortBy": null, "dtoFilter": null, "dtoSourceFilter": null, "withTargetSnapshot": false, "calculationContext": null, "allowBatching": null, "disableAutoIndexing": null, "validationLogic": null, "calcItemsLookupTableId": 2147484066, "schedules": null, "jstId": null, "progressInfo": null, "numberOfItems": 0, "actionUUID": null, "testRow": null, "testResult": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": null, "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [], "resultFields": null, "allocationFields": null, "targetFields": null }, "resultTableUniqueName": null, "adhocDataLoadDefinition": null, "pre80CalculationConfig": null, "requestTime": 1638456932000, "lastUpdateTime": 1638456932000, "loadCompleteTime": null, "createDate": "2021-12-02T14:55:32", "createdBy": 2147490696, "lastUpdateDate": "2021-12-02T14:55:32", "lastUpdateBy": 2147490696, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "isDefault": false, "incremental": true, "distributed": false, "continuous": false, "valid": false, "isPlasma": false, "incLoadDate": null } ], "status": 0 } } } } } } } } }, "parameters": [] }, "/datamart.massedit/{typedId}": { "post": { "summary": "Mass Edit", "operationId": "post-datamart.massedit", "responses": { "200": { "description": "OK - returns the number of edited records.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "massEditDatamartResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" } } } } }, "examples": { "massEditResponseExample": { "value": { "response": { "node": "e2e-staging-node", "data": [ "121" ], "status": 0 } } } } } } } }, "tags": [ "Data Manager" ], "description": "Performs a Mass Edit operation on specified Datamart object - changes values of the specified field (column).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "massEditRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "massEditRecords" ], "properties": { "filterCriteria": { "type": "object" }, "massEditRecords": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "The name of the column whose values you want to change." }, "massEditOperator": { "type": "string", "minLength": 1 }, "fieldValue": { "type": "string", "minLength": 1, "description": "New column values." }, "precision": {} }, "required": [ "fieldName", "massEditOperator", "fieldValue" ] } } } } }, "required": [ "data" ] }, "examples": { "massEditRequestExample": { "value": { "data": { "filterCriteria": {}, "massEditRecords": [ { "fieldName": "currency", "massEditOperator": "=", "fieldValue": "EUR", "precision": null } ] } } } } } } } }, "parameters": [ { "schema": { "type": "string", "example": "2147483653.DMDS" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the object you want to perform the mass edit action for." } ] }, "/datamart.getdataloads": { "post": { "summary": "List Data Loads (with validation and schedules)", "operationId": "post-datamart.getdataloads", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listDataLoadsWithValidationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "targetName": { "type": "string", "minLength": 1 }, "withTargetSnapshot": { "type": "boolean" }, "calculationContext": { "type": "string", "minLength": 1 }, "calcItemsLookupTableId": { "type": "number" }, "schedules": { "type": "array", "items": { "properties": {} } }, "numberOfItems": { "type": "number" }, "actionUUID": { "type": "string", "minLength": 1 }, "resultTableUniqueName": { "type": "string", "minLength": 1 }, "calculationConfig": { "type": "object", "properties": { "formulaName": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "feederInputParams": { "type": "array", "items": { "properties": {} } }, "inputParams": { "type": "array", "items": { "properties": {} } }, "mappingParams": { "type": "array", "items": { "properties": {} } }, "outputElements": { "type": "array", "items": { "properties": {} } } } }, "requestTime": { "type": "number" }, "lastUpdateTime": { "type": "number" }, "loadCompleteTime": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "distributed": { "type": "boolean" }, "continuous": { "type": "boolean" }, "valid": { "type": "boolean" }, "isPlasma": { "type": "boolean" }, "incLoadDate": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Data Manager" ], "description": "Returns a list of Data Load definitions. If fetching Data Loads takes too long and you don't need validation and schedules, use the **List Data Loads** (`/datamart.listdataloads`) endpoint instead." } }, "/datamart.listdataloads": { "post": { "summary": "List Data Loads", "operationId": "post-datamart.listdataloads", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listDataLoadsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "targetName": { "type": "string", "minLength": 1 }, "withTargetSnapshot": { "type": "boolean" }, "calculationContext": { "type": "string", "minLength": 1 }, "calcItemsLookupTableId": { "type": "number" }, "numberOfItems": { "type": "number" }, "actionUUID": { "type": "string", "minLength": 1 }, "resultTableUniqueName": { "type": "string", "minLength": 1 }, "calculationConfig": { "type": "object", "properties": { "formulaName": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "feederInputParams": { "type": "array", "items": { "type": "object" } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object" } } } }, "requestTime": { "type": "number" }, "lastUpdateTime": { "type": "number" }, "loadCompleteTime": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "distributed": { "type": "boolean" }, "continuous": { "type": "boolean" }, "valid": { "type": "boolean" }, "isPlasma": { "type": "boolean" }, "incLoadDate": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Data Manager" ], "description": "Returns a list of Data Load definitions. No validation is run on returned Data Loads and no schedules are loaded. Use this endpoint for listing only.

If you need Data Loads to be validated and schedules returned, use the **List Data Loads (with validation and schedules)** (`/datamart.getdataloads`) endpoint instead." }, "parameters": [] }, "/datamart.deletefc/{TypeCode}": { "post": { "summary": "Delete a Data Manager Entity", "operationId": "post-datamart.deletefc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteDataManagerEntityResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "Data Manager" ], "description": "Deletes a field collection (FC) definition, i.e. Data Feed (`DMF`), Datamart (`DM`), or Data Source (`DMDS`).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteDataManagerEntityRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string", "minLength": 1 } }, "required": [ "uniqueName" ] } }, "required": [ "data" ] }, "examples": { "deleteDMentityRequestExample": { "value": { "data": { "uniqueName": "Transactions" } } } } } } } }, "parameters": [ { "schema": { "type": "string", "enum": [ "DM", "DMF", "DMDS" ], "example": "DMDS" }, "name": "TypeCode", "in": "path", "required": true, "description": "The type code of the **Field Collection** you want to delete." } ] }, "/datamart.query": { "post": { "summary": "Query a Data Manager Object", "operationId": "post-datamart.query", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "queryDataManagerObjectResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "bandBy": { "type": "string", "minLength": 1 }, "bubbleSize": { "type": "number" }, "bubbleSize_n": { "type": "number" }, "groupBy": { "type": "string", "minLength": 1 }, "x": { "type": "number" }, "y": { "type": "number" }, "summary": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "e2e-staging-node", "startRow": 0, "data": [ { "bandBy": "CD-0004", "bubbleSize": 548, "bubbleSize_n": 0.292108362779741, "groupBy": "Europe", "x": 12075200, "y": 220350.364963504, "summary": "{\"projections\":{\"y\":{\"LRa\":239348.912312387,\"ERa\":237200.359912615,\"Sum\":15041879.5665948,\"Avg\":250697.992776579,\"Mean\":250697.992776579,\"Min\":93904.7619047619,\"Max\":353076.923076923,\"Std\":46309.6235068131,\"Q.05\":166714.083007813,\"Q.1\":196816.897460938,\"Q.2\":219184.366210938,\"Q.25\":226486.880371094,\"Q.3\":236223.565917969,\"Q.4\":243526.080078125,\"Q.5\":249915.779968262,\"Q.6\":258131.108398438,\"Q.7\":271519.051025391,\"Q.75\":280038.650878906,\"Q.8\":290262.170703125,\"Q.9\":311682.878906250,\"Q.95\":331156.250000000,\"Hist\":{\"118174.538085938\":1,\"154579.196777344\":2,\"178848.969238281\":1,\"193900.376464844\":2,\"199733.418457031\":1,\"205566.460449219\":2,\"211399.502441406\":1,\"217967.280517578\":3,\"225269.794677734\":3,\"232572.308837891\":2,\"238049.194458008\":2,\"241700.451538086\":4,\"245351.708618164\":2,\"248090.151428223\":3,\"249915.779968262\":2,\"254479.851318359\":5,\"261782.365478516\":1,\"267259.251098633\":3,\"270910.508178711\":3,\"276387.393798828\":2,\"283689.907958984\":2,\"294643.679199219\":5,\"309248.707519531\":3,\"323853.735839844\":2,\"342116.593750000\":3}},\"x\":{\"LRb\":0.000564991849158590,\"ERb\":2.44510211980881E-9,\"Sum\":1118727900.00000,\"Avg\":18645465.0000000,\"Mean\":18645465.0000000,\"Min\":1183200.00000000,\"Max\":41407200.0000000,\"Std\":12268723.3236501,\"Q.05\":2081450.00000000,\"Q.1\":3481156.25000000,\"Q.2\":5028200.00000000,\"Q.25\":6796250.00000000,\"Q.3\":8564300.00000000,\"Q.4\":12954533.3333333,\"Q.5\":16979450.0000000,\"Q.6\":22194221.8750000,\"Q.7\":25844716.6666667,\"Q.75\":28035013.5416667,\"Q.8\":30955409.3750000,\"Q.9\":36650181.2500000,\"Q.95\":39951862.5000000,\"Hist\":{\"1260425.00000000\":1,\"1414875.00000000\":1,\"2376125.00000000\":3,\"3702162.50000000\":4,\"4586187.50000000\":3,\"5912225.00000000\":3,\"7238262.50000000\":1,\"8122287.50000000\":2,\"9149450.00000000\":1,\"10942075.0000000\":4,\"13357025.0000000\":3,\"15168237.5000000\":2,\"16375712.5000000\":2,\"18491687.5000000\":2,\"21099073.4375000\":4,\"23289370.3125000\":4,\"25479667.1875000\":3,\"27669964.0625000\":3,\"30955409.3750000\":4,\"35336003.1250000\":5,\"38496525.0000000\":1,\"40436975.0000000\":4}}},\"Count\":60}" }, { "bandBy": "CD-0008", "bubbleSize": 355, "bubbleSize_n": 0.178445229681979, "groupBy": "Asia", "x": 11279100, "y": 296039.37007874 }, { "bandBy": "CD-0001", "bubbleSize": 405, "bubbleSize_n": 0.207891637220259, "groupBy": "Europe", "x": 10922500, "y": 269691.358024691 } ], "endRow": 3, "totalRows": 3, "status": 0 } } } } } } } }, "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "queryDataManagerObjectRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "endRow": { "type": "number" }, "sortBy": { "type": "array", "items": { "type": "object" } }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "query": { "type": "object", "properties": { "name": {}, "datamart": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "source": { "type": "string", "minLength": 1 }, "projections": { "type": "object", "required": [ "bandBy" ], "properties": { "bandBy": { "type": "object", "required": [ "alias", "expression", "function", "parameters", "name", "label" ], "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": { "type": "string" }, "parameters": { "type": "object" }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } }, "bubbleSize": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": {}, "parameters": { "type": "object", "required": [ "field", "quantity", "base" ], "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } } }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "default": {}, "advancedProjection": { "type": "boolean" }, "formatString": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "parameters", "name", "label", "advancedProjection", "formatString" ] }, "bubbleSize_n": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": {}, "parameters": { "type": "object", "required": [ "field", "quantity", "base" ], "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } } }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "default": {}, "advancedProjection": { "type": "boolean" }, "formatString": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "parameters", "name", "label", "advancedProjection", "formatString" ] }, "groupBy": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": { "type": "string" }, "parameters": { "type": "object" }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "function", "parameters", "name", "label" ] }, "x": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": {}, "parameters": { "type": "object", "required": [ "field", "quantity", "base" ], "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } } }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "default": {}, "advancedProjection": { "type": "boolean" }, "formatString": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "parameters", "name", "label", "advancedProjection", "formatString" ] }, "y": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "function": {}, "parameters": { "type": "object", "required": [ "field", "quantity", "base" ], "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } } }, "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "default": {}, "advancedProjection": { "type": "boolean" }, "formatString": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "parameters", "name", "label", "advancedProjection", "formatString" ] } } }, "options": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1 }, "regression": { "type": "array", "items": { "type": "string" } }, "distribution": { "type": "array", "items": { "type": "string" } }, "normalization": { "type": "array", "items": { "type": "string" } } } }, "filter": { "type": "object", "properties": { "criteria": { "type": "array", "items": { "type": "string" } }, "operator": { "type": "string", "minLength": 1 }, "_constructor": { "type": "string", "minLength": 1 } } }, "aggregateFilter": {}, "dimensionFilters": { "type": "array", "items": { "type": "object" } }, "limit": {}, "rollup": { "type": "boolean" }, "sortBy": { "type": "array", "items": { "type": "object" } } }, "required": [ "datamart", "source", "projections" ] } } }, "oldValues": {} }, "required": [ "data" ] }, "examples": { "queryDMObjectRequestExample": { "value": { "operationType": "fetch", "startRow": 0, "endRow": 100000, "sortBy": [], "textMatchStyle": "exact", "data": { "query": { "name": null, "datamart": "DM.TransactionsDM", "label": "Series1", "source": "DM.TransactionsDM", "projections": { "bandBy": { "alias": "bandBy", "expression": "CustomerID", "function": "", "parameters": {}, "name": "CustomerID", "label": "CustomerID" }, "bubbleSize": { "alias": "bubbleSize", "expression": "SUM({field})", "function": null, "parameters": { "field": "Quantity", "quantity": "Quantity", "base": "ListPrice" }, "name": "Quantity", "label": "∑Quantity", "default": null, "advancedProjection": true, "formatString": "∑{field}" }, "bubbleSize_n": { "alias": "bubbleSize_n", "expression": "SUM({field})", "function": null, "parameters": { "field": "Quantity", "quantity": "Quantity", "base": "ListPrice" }, "name": "Quantity", "label": "∑Quantity (norm)", "default": null, "advancedProjection": true, "formatString": "∑{field}" }, "groupBy": { "alias": "groupBy", "expression": "Region", "function": "", "parameters": {}, "name": "Region", "label": "Region" }, "x": { "alias": "x", "expression": "SUM({field})", "function": null, "parameters": { "field": "BasePrice", "quantity": "Quantity", "base": "ListPrice" }, "name": "BasePrice", "label": "∑BasePrice", "default": null, "advancedProjection": true, "formatString": "∑{field}" }, "y": { "alias": "y", "expression": "SUM({field})/SUM({quantity})", "function": null, "parameters": { "field": "ListPrice", "quantity": "Quantity", "base": "ListPrice" }, "name": "ListPrice", "label": "∑ListPrice/∑Quantity", "default": null, "advancedProjection": true, "formatString": "∑{field}/∑{quantity}" } }, "options": { "currency": "EUR", "regression": [ "y", "x" ], "distribution": [ "m1", "x", "y" ], "normalization": [ "bubbleSize_n" ] }, "filter": { "criteria": [], "operator": "and", "_constructor": "AdvancedCriteria" }, "aggregateFilter": null, "dimensionFilters": [], "limit": null, "rollup": true, "sortBy": [] } }, "oldValues": null } } } } } }, "description": "Returns a list of objects that match the criteria specified in the request.", "parameters": [ { "$ref": "#/components/parameters/timeout" } ] } }, "/datamart.sqlquery": { "post": { "summary": "SQL Query a Data Manager Object", "operationId": "post-datamart.sqlquery", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "queryDataManagerObjectResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "bandBy": { "type": "string", "minLength": 1 }, "bubbleSize": { "type": "number" }, "bubbleSize_n": { "type": "number" }, "groupBy": { "type": "string", "minLength": 1 }, "x": { "type": "number" }, "y": { "type": "number" }, "summary": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "e2e-staging-node", "startRow": 0, "data": [ { "bandBy": "CD-0004", "bubbleSize": 548, "bubbleSize_n": 0.292108362779741, "groupBy": "Europe", "x": 12075200, "y": 220350.364963504, "summary": "{\"projections\":{\"y\":{\"LRa\":239348.912312387,\"ERa\":237200.359912615,\"Sum\":15041879.5665948,\"Avg\":250697.992776579,\"Mean\":250697.992776579,\"Min\":93904.7619047619,\"Max\":353076.923076923,\"Std\":46309.6235068131,\"Q.05\":166714.083007813,\"Q.1\":196816.897460938,\"Q.2\":219184.366210938,\"Q.25\":226486.880371094,\"Q.3\":236223.565917969,\"Q.4\":243526.080078125,\"Q.5\":249915.779968262,\"Q.6\":258131.108398438,\"Q.7\":271519.051025391,\"Q.75\":280038.650878906,\"Q.8\":290262.170703125,\"Q.9\":311682.878906250,\"Q.95\":331156.250000000,\"Hist\":{\"118174.538085938\":1,\"154579.196777344\":2,\"178848.969238281\":1,\"193900.376464844\":2,\"199733.418457031\":1,\"205566.460449219\":2,\"211399.502441406\":1,\"217967.280517578\":3,\"225269.794677734\":3,\"232572.308837891\":2,\"238049.194458008\":2,\"241700.451538086\":4,\"245351.708618164\":2,\"248090.151428223\":3,\"249915.779968262\":2,\"254479.851318359\":5,\"261782.365478516\":1,\"267259.251098633\":3,\"270910.508178711\":3,\"276387.393798828\":2,\"283689.907958984\":2,\"294643.679199219\":5,\"309248.707519531\":3,\"323853.735839844\":2,\"342116.593750000\":3}},\"x\":{\"LRb\":0.000564991849158590,\"ERb\":2.44510211980881E-9,\"Sum\":1118727900.00000,\"Avg\":18645465.0000000,\"Mean\":18645465.0000000,\"Min\":1183200.00000000,\"Max\":41407200.0000000,\"Std\":12268723.3236501,\"Q.05\":2081450.00000000,\"Q.1\":3481156.25000000,\"Q.2\":5028200.00000000,\"Q.25\":6796250.00000000,\"Q.3\":8564300.00000000,\"Q.4\":12954533.3333333,\"Q.5\":16979450.0000000,\"Q.6\":22194221.8750000,\"Q.7\":25844716.6666667,\"Q.75\":28035013.5416667,\"Q.8\":30955409.3750000,\"Q.9\":36650181.2500000,\"Q.95\":39951862.5000000,\"Hist\":{\"1260425.00000000\":1,\"1414875.00000000\":1,\"2376125.00000000\":3,\"3702162.50000000\":4,\"4586187.50000000\":3,\"5912225.00000000\":3,\"7238262.50000000\":1,\"8122287.50000000\":2,\"9149450.00000000\":1,\"10942075.0000000\":4,\"13357025.0000000\":3,\"15168237.5000000\":2,\"16375712.5000000\":2,\"18491687.5000000\":2,\"21099073.4375000\":4,\"23289370.3125000\":4,\"25479667.1875000\":3,\"27669964.0625000\":3,\"30955409.3750000\":4,\"35336003.1250000\":5,\"38496525.0000000\":1,\"40436975.0000000\":4}}},\"Count\":60}" }, { "bandBy": "CD-0008", "bubbleSize": 355, "bubbleSize_n": 0.178445229681979, "groupBy": "Asia", "x": 11279100, "y": 296039.37007874 }, { "bandBy": "CD-0001", "bubbleSize": 405, "bubbleSize_n": 0.207891637220259, "groupBy": "Europe", "x": 10922500, "y": 269691.358024691 } ], "endRow": 3, "totalRows": 3, "status": 0 } } } } } } } }, "tags": [ "Data Manager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "endRow": { "type": "integer" }, "data": { "type": "object", "properties": { "sources": { "type": "object", "properties": { "s0": { "type": "object", "properties": { "query": { "type": "object", "properties": { "source": { "type": "string" }, "projections": { "type": "object", "properties": { "Month": { "type": "object", "properties": { "expression": { "type": "string" } } }, "Quantity": { "type": "object", "properties": { "expression": { "type": "string" }, "parameters": { "type": "object", "properties": { "field": { "type": "string" } } }, "advancedProjection": { "type": "boolean" } } } } }, "options": { "type": "object", "properties": { "currency": { "type": "string" } } }, "filter": { "type": "object" }, "aggregateFilter": {}, "dimensionFilters": { "type": "array", "items": { "type": "object", "properties": { "Invoice_DateYear": { "type": "array", "items": { "type": "string" } } } } }, "rollup": { "type": "boolean" } } } } }, "s1": { "type": "object", "properties": { "query": { "type": "object", "properties": { "source": { "type": "string" }, "projections": { "type": "object", "properties": { "Month": { "type": "object", "properties": { "expression": { "type": "string" } } }, "Quantity": { "type": "object", "properties": { "expression": { "type": "string" }, "parameters": { "type": "object", "properties": { "field": { "type": "string" } } }, "advancedProjection": { "type": "boolean" } } } } }, "options": { "type": "object", "properties": { "currency": { "type": "string" } } }, "filter": { "type": "object" }, "aggregateFilter": {}, "dimensionFilters": { "type": "array", "items": { "type": "object", "properties": { "Invoice_DateYear": { "type": "array", "items": { "type": "string" } } } } }, "rollup": { "type": "boolean" } } } } } } }, "with": { "type": "object", "properties": { "w0": { "type": "string" } } }, "sql": { "type": "string" } } } } }, "examples": { "queryDMObjectRequestExample": { "value": { "operationType": "fetch", "startRow": 0, "endRow": 10000, "data": { "sources": { "s0": { "query": { "source": "DM.InvoicesDM", "projections": { "Month": { "expression": "Invoice_DateMonth" }, "Quantity": { "expression": "SUM({field})", "parameters": { "field": "Sales_Quantity" }, "advancedProjection": true } }, "options": { "currency": "EUR" }, "filter": {}, "aggregateFilter": null, "dimensionFilters": [ { "Invoice_DateYear": [ "2019" ] } ], "rollup": true } }, "s1": { "query": { "source": "DM.InvoicesDM", "projections": { "Month": { "expression": "Invoice_DateMonth" }, "Quantity": { "expression": "SUM({field})", "parameters": { "field": "Sales_Quantity" }, "advancedProjection": true } }, "options": { "currency": "EUR" }, "filter": {}, "aggregateFilter": null, "dimensionFilters": [ { "Invoice_DateYear": [ "2020" ] } ], "rollup": true } } }, "with": { "w0": "SELECT Month FROM (VALUES ('M01'), ('M02'), ('M03'), ('M04'), ('M05'), ('M06'), ('M07'), ('M08'), ('M09'), ('M10'), ('M11'), ('M12')) AS t(Month)" }, "sql": "SELECT w0.Month \"Month\", SUM(s0.quantity) \"Volume 2019\", SUM(s1.quantity) \"Volume 2020\", 100 * (SUM(s1.quantity) / SUM(s0.quantity) - 1.0) \"VolumeΔ%\" FROM w0 LEFT OUTER JOIN s0 ON w0.Month = RIGHT(s0.Month,3) LEFT OUTER JOIN s1 ON w0.Month = RIGHT(s1.Month,3) GROUP BY w0.Month ORDER BY w0.Month" } } } } } }, "description": "`sources` that SQL can use are query definitions. The sources become CTEs (Common Table Expression) in the final SQL. These are then used as a reference in the main query instead of referring to the actual tables directly. The request example compares the volume by month 2019 to 2020." }, "description": "Processes and queries data from Price Analyzer or Price Optimizer. The queries can be aggregated, do various computations including statistical projections. Supports filtering.", "parameters": [ { "$ref": "#/components/parameters/timeout" } ] }, "parameters": [] }, "/datamart.getrollups": { "post": { "summary": "List Rollups", "operationId": "post-datamart.getrollups", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listRollupsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "queryDto": { "type": "object", "properties": { "projections": { "type": "object", "properties": { "Region": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "name" ] }, "Country": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "name" ] }, "Product ID": { "type": "object", "properties": { "alias": { "type": "string", "minLength": 1 }, "expression": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "alias", "expression", "name" ] }, "Costs": { "type": "object", "properties": { "advancedProjection": { "type": "boolean" }, "expression": { "type": "string", "minLength": 1 }, "parameters": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } }, "required": [ "field", "quantity", "base" ] }, "formatString": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 } } }, "Margin %": { "type": "object", "properties": { "advancedProjection": { "type": "boolean" }, "expression": { "type": "string", "minLength": 1 }, "parameters": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } }, "required": [ "field", "quantity", "base" ] }, "formatString": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 } } }, "List Price": { "type": "object", "properties": { "advancedProjection": { "type": "boolean" }, "expression": { "type": "string", "minLength": 1 }, "parameters": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1 }, "quantity": { "type": "string", "minLength": 1 }, "base": { "type": "string", "minLength": 1 } }, "required": [ "field", "quantity", "base" ] }, "formatString": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "alias": { "type": "string", "minLength": 1 } } } } }, "options": { "type": "object", "properties": { "currency": { "type": "string", "minLength": 1 } } }, "sortBy": { "type": "array", "items": { "type": "object" } }, "source": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "filters": { "type": "object" }, "datamart": { "type": "string", "minLength": 1 }, "rollup": { "type": "boolean" } } }, "createdByName": { "type": "string", "minLength": 1 }, "visibility": { "type": "string", "minLength": 1 }, "draft": { "type": "boolean" }, "ownerAndLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "isPlasma": { "type": "boolean" } } } }, "endRow": { "type": "number" } } } } } } } } }, "tags": [ "Data Manager" ], "description": "Retrieves a list of Datamart Rollups based on filter settings.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listRollupsRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "endRow": {}, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": {}, "_constructor": { "type": "string", "minLength": 1 } } }, "oldValues": {} } }, "examples": { "listRollupsRequestExample": { "value": { "operationType": "fetch", "startRow": 0, "endRow": null, "textMatchStyle": "substring", "data": { "fieldName": "owner", "operator": "equals", "value": null, "_constructor": "AdvancedCriteria" }, "oldValues": null } } } } } } } }, "/datamart.getcharts": { "post": { "summary": "List Charts", "operationId": "post-datamart.getcharts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listChartsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "chartDefinition": { "type": "string", "minLength": 1 }, "externalChartDefinition": { "type": "string", "minLength": 1 }, "visibility": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "chartType": { "type": "string", "minLength": 1 }, "nodeId": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "endRow": { "type": "number" } } } } } } } } }, "tags": [ "Data Manager" ], "description": "Retrieves a list of saved charts, including chart's details." } }, "/datamart.importdataloads": { "post": { "summary": "Import a Data Load", "operationId": "post-datamart.importdataloads", "responses": { "200": { "description": "OK" } }, "tags": [ "Data Manager" ], "description": "Imports a list of Data Load definitions. Existing definitions will be updated.\n\n>**Information**:\n>Omitting a property is equivalent to setting it to **null**. With one exception: a previously existing `incLoadDate` will be retained.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "importDataLoadRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "dataLoads" ], "properties": { "dataLoads": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "targetName": { "type": "string", "minLength": 1 }, "sourceName": { "type": "string", "minLength": 1 }, "continuous": { "type": "boolean" }, "incremental": { "type": "boolean" }, "incLoadDate": { "type": "string", "minLength": 1 }, "calculationMessages": { "type": "array", "items": { "type": "object" } }, "valid": { "type": "string", "minLength": 1 } }, "required": [ "typedId", "type", "targetName" ] } } } } }, "required": [ "data" ] } } } } } }, "/datamart.exportdata/xlsx": { "post": { "summary": "Export an Excel File (XLSX)", "operationId": "post-datamart.exportdata-xlsx", "responses": { "200": { "description": "OK - returns the XLSX file (binary data):\n`Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`" } }, "tags": [ "Data Manager" ], "description": "Downloads an XLSX file. The returned file contains all **definitions** (meta) and the **data**.\nThis is useful for importing the Data Source, Datamart, or Data Feed definitions + data in some other instance or partition.\n", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "exportExcelFileRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "fieldCollections", "sanitize" ], "properties": { "fieldCollections": { "type": "array", "items": { "type": "string" } }, "sanitize": { "type": "boolean" } } } }, "required": [ "data" ] }, "examples": { "exportExcelFileRequestExample": { "value": { "data": { "fieldCollections": [ "DMDS.Transactions" ], "sanitize": true } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/timeout" } ] } }, "/datamart.exportdata": { "post": { "summary": "Export a CSV File", "operationId": "post-datamart.exportdata", "responses": { "200": { "description": "OK - returns the ZIP file (binary data):\n`Content-Type: application/zip`" } }, "tags": [ "Data Manager" ], "description": "Downloads a ZIP file. The returned ZIP file contains Data Source, Datamart, or Data Feed definitions in the JSON file and data in the CSV file.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "exportCSVFileRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "fieldCollections", "sanitize" ], "properties": { "fieldCollections": { "type": "array", "items": { "type": "string" } }, "sanitize": { "type": "boolean" } } } }, "required": [ "data" ] }, "examples": { "exportCSVFileRequestExample": { "value": { "data": { "fieldCollections": [ "DMDS.Transactions" ], "sanitize": true } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/timeout" } ] }, "parameters": [] }, "/datamart.fetchexportfile/{fileName}": { "post": { "summary": "Get a DM Export File", "operationId": "post-datamart.fetchexportfile-fileName", "tags": [ "Data Manager" ], "description": "Retrieves the file created using `/datamart.export` endpoint. Get the file name via `datamart.getactionstatus/{actionUUID}` endpoint.", "parameters": [], "responses": { "200": { "description": "OK" } } }, "parameters": [ { "schema": { "type": "string", "example": "DMDS.Txn_PO_Test_0001_part_00.gz" }, "name": "fileName", "in": "path", "required": true, "description": "The name of the file previously created by a `datamart.export` request. The filename needs to be an exact match - no wildcards allowed, hence only one file at the time can be fetched." } ] }, "/datamart.getactionstatus/{actionUUID}": { "post": { "summary": "Get Action Status", "operationId": "post-datamart.getactionstatus-actionUUID", "tags": [ "Data Manager" ], "description": "Retrieves the link of the exported file in the `result` property. Use the `/datamart.fetchexportfile/{fileName}` to download the file.", "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getActionStatusResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "actionUUID": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "executionNode": { "type": "string", "minLength": 1 }, "executionThread": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "cancelRequested": { "type": "boolean" }, "skippedOps": { "type": "array", "items": { "type": "object" } }, "result": { "type": "object", "properties": { "DM.TransactionsDM": { "type": "string", "minLength": 1 } } }, "calculationMessages": { "type": "array", "items": { "type": "object" } }, "validationErrors": {} } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "getActionStatusResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-689c85c8b6-qqmd9", "startRow": 0, "data": [ { "actionUUID": "ExportAction-CL3WG", "createDate": "2022-03-02", "lastUpdateDate": "2022-03-02", "executionNode": "pricefx-cluster-app-frontend-689c85c8b6-srhk2", "executionThread": "ExportAction-CL3WG", "status": "READY", "cancelRequested": false, "skippedOps": [], "result": { "DM.TransactionsDM": "s3://postgres-pricefx-eu-west-1/e2e-aws-staging/seeddata/export/DM.TransactionsDM.csv.gz" }, "calculationMessages": [], "validationErrors": null } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "actionUUID", "in": "path", "required": true } ] }, "/datamart.export/{fcTypedIdOrSourceName}": { "post": { "summary": "Export Datamart", "operationId": "post-datamart.export", "tags": [ "Data Manager" ], "description": "Exports the specified Datamart source. Typically used in an integration scenario (IM) for a given customer. The request’s body can contain a data block with a regular filter criteria definition (as, for example, used in the JSON API fetch commands), to filter the output rows.

\nIf the Analytics database for the parition is hosted in AWS, the export file(s) will be transferred to the corresponding S3 bucket, ready for retrieval using the `datamart.fetchexportfile` (Get a DM Export File) endpoint.\nOtherwise the files are put in the local file system of the node that handles the request:\n\ndefault path: `server/temp//export//`\n\nIf needed, a different, absolute path can be set using an instance parameter:\n\n`datamart.database.export.path`\n\nData is exported in the CSV format, and is always gzip-compressed. Character encoding is always UTF-8. There is no client side encryption.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "suffix", "description": "A suffix appended to the standard output file name: `__.csv.gz`" }, { "schema": { "type": "string" }, "in": "query", "name": "maxRows", "description": "The maximum number of returned rows." } ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "exportDatamartRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "operator": { "type": "string", "minLength": 1 }, "fieldName": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "operator": { "type": "string", "minLength": 1 } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "exportDatamartResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "actionUUID": { "type": "array", "description": "Use this in the `datamart.getactionstatus/{actionUUID}` endpoint to retrieve a file path of the exported file.", "items": { "type": "object" } } } } }, "status": { "type": "number" } } } } } } } } } }, "parameters": [ { "schema": { "type": "string", "example": "DMDS.SegmentPrices" }, "name": "fcTypedIdOrSourceName", "in": "path", "required": true, "description": "Restricts the export to a specific source, identified by either the 'typedId' or 'sourceName'. " } ] }, "/datamart.restoredefaultds/{dataSourceName}": { "post": { "summary": "Restore Default Data Sources", "operationId": "post-formulamanager.restoredefaultds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "restoreDefaultDataSourcesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object", "properties": { "0": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "sourceFile": {}, "keyFields": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} }, "formulaName": {}, "messages": {}, "reservedWords": {}, "rowCount": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "sourceTypeCode": { "type": "string", "minLength": 1 }, "sourceId": {}, "sourceLabel": { "type": "string", "minLength": 1 }, "fetchVerb": { "type": "string", "minLength": 1 }, "integrateVerb": { "type": "string", "minLength": 1 }, "bulkloadVerb": { "type": "string", "minLength": 1 }, "truncateVerb": { "type": "string", "minLength": 1 }, "identikitCriteria": {}, "sourceName": { "type": "string", "minLength": 1 }, "queryable": { "type": "boolean" }, "identikitFilter": {}, "type": { "type": "string", "minLength": 1 }, "valid": { "type": "boolean" }, "status": {}, "fieldNames": { "type": "array", "items": {} }, "targetDate": {}, "auxiliary": { "type": "boolean" }, "deployed": { "type": "boolean" }, "view": { "type": "boolean" }, "dbTable": { "type": "string", "minLength": 1 }, "dbKey": { "type": "string", "minLength": 1 }, "dbView": {}, "keyFieldNames": { "type": "array", "items": { "type": "object" } }, "loadableFields": { "type": "array", "items": { "type": "object" } }, "calculationMessages": {}, "locked": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "query": {}, "lastDataModificationDate": {}, "persistedObjectClass": { "type": "string", "minLength": 1 }, "warningsOn": { "type": "boolean" }, "isPlasma": { "type": "boolean" }, "typeCode": { "type": "string", "minLength": 1 }, "calculationDate": {}, "calculationStartDate": {} }, "required": [ "typeCode" ] } } } } }, "status": { "type": "number" } } } } }, "examples": {} } } } }, "description": "Creates a default Data Source (Product, Customer, Unit of Measures, Currencies, or Calendar). Use this endpoint if default Data Sources have not been created when setting up the partition.
\n\n>**Note**: When no path parameter is passed, *all* default Data Sources are dropped and recreated - *any data will be lost*.\n>Othwerise, only the Data Source indicated by the path param is dropped and recreated.\n", "tags": [ "Data Manager" ] }, "parameters": [ { "schema": { "type": "string", "enum": [ "Product", "Customer", "uom", "ccy", "cal" ] }, "name": "dataSourceName", "in": "path", "description": "The name of the Data Source you want to create. ", "required": true } ] }, "/datamart.importfile/{slotId}/{typedId}": { "post": { "summary": "Import a File", "operationId": "post-datamart.importfile", "responses": { "200": { "description": "OK" } }, "tags": [ "Data Manager" ], "description": "Uploads a file to the Data Manager (specified by `typeId` in the path parameter).

\n> To import data into FieldCollection (DMT or DMDS), use the `datamart.loadfc/{typedId}` endpoint.

\nFollow these steps to upload a file:

\n1. Create an upload slot and retrieve the **slotId** using the **/uploadmanager.newuploadslot** endpoint (see **Product Image** > **1. Create an Upload Slot**).\n2. Upload the file using the **/datamart.importfile/{slotId}/{typedId}** endpoint.

\n\nWhen importing a CSV file, it is possible to include more information than just a column name.
\nExample:
\n```\ncolumName1:NUMBER:KEY,columnName2:TEXT:DIM,columnName3:NUMBER\na,1,0.5\nb,1,0.6\nc,2,1.2\nd,3,2.0\n```\nIn the example above you can see that **columnName1** column should be the `NUMBER` field type and also the **key** (`KEY`).
\nThe **columnName2** column should be the `TEXT` type and a **dimension** (`DIM`).
\nThe **columnName3** column should be a `NUMBER`.
\n**Possible field types**: `BOOLEAN`, `CURRENCY`, `DATE`, `DATETIME`, `INTEGER`, `LOB`, `MONEY`, `NUMBER`, `QUANTITY`, `TEXT`, `UOM`

\n\n>**Information**: When using datamart.importfile to upload a file with huge numbers (20+ significant decimal digits) it is recommended to use the [Avro format](https://avro.apache.org/docs/current/spec.html). In CSV and XLSX files, you can use numbers within the double type or long type ranges.\n

\n" }, "parameters": [ { "schema": { "type": "string" }, "name": "slotId", "in": "path", "required": true, "description": "The `id` of the slot. Create the slot and retrieve the `id` using the **/uploadmanager.newuploadslot** endpoint." }, { "schema": { "type": "string", "example": "2147483847.DMDS" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Data Manager entity." } ] }, "/formulamanager.getdefault": { "post": { "summary": "Get a Default Pricing Logic Name", "operationId": "post-formulamanager.getdefault", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getDefaultPricingLogicNameResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "label": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Retrieves `uniqueName` of the default pricing logic." } }, "/formulamanager.setdefault/{uniqueName}": { "post": { "summary": "Set a Default Pricing Logic", "operationId": "post-formulamanager.setdefault-uniqueName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "setDefaultPricingLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "label": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Sets the default pricing logic. To clear the default pricing logic, use **/formulamanager.setdefault** without the `uniqueName` path parameter." }, "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic that will be set as default. Leave blank to clear the default pricing logic." } ] }, "/formulamanager.update/{id}": { "parameters": [ { "schema": { "type": "string", "example": "2147484837" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837**." } ], "post": { "summary": "Update a Logic", "operationId": "post-formulamanager.update-logicId", "responses": { "200": { "$ref": "#/components/responses/logicResponse" } }, "tags": [ "Logics" ], "description": "Updates the given logic.\n\n>**Information**:\n>If changes in the code (in the particular Groovy code) of some elements are made, it is highly recommended to use the update endpoint with *compileOnly* (**/formulamanager.update/{logicId}/compileOnly**) for optimal performance.", "requestBody": { "$ref": "#/components/requestBodies/pricingLogicObject" } } }, "/formulamanager.update/{id}/incremental": { "parameters": [ { "schema": { "type": "string", "example": "2147484837" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837**." } ], "post": { "summary": "Update a Logic (Partial)", "operationId": "post-formulamanager.update-id-incremental", "responses": { "200": { "$ref": "#/components/responses/logicResponse" } }, "tags": [ "Logics" ], "description": "Performs a partial update of the specified logic. Recompiles only those logic elements whose `formulaExpression` has been changed.\n\n>**Information**:\n>If changes in the code (in the particular Groovy code) of some elements are made, it is highly recommended to use the update endpoint with *compileOnly* (**/formulamanager.update/{logicId}/incremental/compileOnly**) for optimal performance.", "requestBody": { "$ref": "#/components/requestBodies/pricingLogicObject" } } }, "/formulamanager.update/{id}/compileOnly": { "parameters": [ { "schema": { "type": "string", "example": "2147484837" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837**." } ], "post": { "summary": "Update a Logic (No syntax check)", "operationId": "post-formulamanager.update-logicId-compileOnly", "responses": { "200": { "$ref": "#/components/responses/logicResponse" } }, "tags": [ "Logics" ], "description": "Updates the given logic. **Skips the syntax check**. Groovy compilation errors will still surface, but regular syntax errors could go unnoticed. Use with care!\n\n>**Information**:\n> Skipping the syntax check is useful for better performance when the logic does not contain any inputs. If the logic contains inputs, the syntax check is needed.", "requestBody": { "$ref": "#/components/requestBodies/pricingLogicObject" } } }, "/formulamanager.getelementnames/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to list elements for." } ], "post": { "summary": "List Elements", "operationId": "post-formulamanager.getelementnames-uniqueName", "tags": [ "Logics" ], "description": "Returns all logic element names and labels, except elements where the **Display Mode** (`displayOptions`) is set to *Never*.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listElementsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "object" }, "status": { "type": "integer" } } } } } } } } } } }, "/formulamanager.execute/{sku}": { "parameters": [ { "schema": { "type": "string" }, "name": "sku", "in": "path", "required": true, "description": "The `sku` or `typedId` of the product you want to execute the logic for." } ], "post": { "summary": "Execute an Assigned Logic", "operationId": "post-formulamanager.execute-sku", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeAssignedLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "string", "minLength": 1 }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object" } }, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName" ] } }, "status": { "type": "number" } } } } } } } } }, "description": "Executes a logic that is assigned to the given product (specified by `sku` or `typedId`) and calculates the result. The result content is defined partially by the visibility flags that are part of the logic master data.", "tags": [ "Logics", "Products" ], "requestBody": { "$ref": "#/components/requestBodies/executeLogic" } } }, "/formulamanager.execute/{sku}/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "sku", "in": "path", "required": true, "description": "The `sku` or `typedId` of the product you want to execute the assigned logic for." }, { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to execute." } ], "post": { "summary": "Execute a Logic", "operationId": "post-formulamanager.execute-sku-uniqueName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "string", "minLength": 1 }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object" } }, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName" ] } }, "status": { "type": "number" } } } } } } } } }, "description": "Executes a logic (specified by `uniqueName`) that is assigned to the given product (specified by `sku` or `typedId`) and calculates the result. The result content is defined partially by the visibility flags that are part of the logic master data.", "tags": [ "Logics", "Products" ], "requestBody": { "$ref": "#/components/requestBodies/executeLogic" } } }, "/formulamanager.delete/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic you want to delete. `id` is the `typedId` without **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484835.F** is **2147484835**." } ], "post": { "summary": "Delete a Logic", "operationId": "post-formulamanager.delete-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": {}, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaNature": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "formulaType": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Deletes a logic, including all elements." } }, "/formulamanager.getnames": { "post": { "summary": "List Logics", "operationId": "post-formulamanager.getnames", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listLogicsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Retrieves a list (`uniqueName` and `label`) of all logics in the partition you are currently authenticated for." } }, "/formulamanager.testparams": { "post": { "summary": "Generate Parameters", "operationId": "post-formulamanager.testparams", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "generateParametersResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "object" }, "status": { "type": "integer" } } } } } } } } }, "description": "Retrieves a list of parameters and their Nature for a given formula.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "generateParametersRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "targetDate", "testFormula" ], "properties": { "targetDate": { "type": "string", "minLength": 1, "description": "The validity date of the formula." }, "item": { "type": "string" }, "testFormula": { "type": "object", "required": [ "elements", "status", "uniqueName", "validAfter", "__PROC" ], "description": "JSON that represents the whole draft formula (the same format as used for the update command).", "properties": { "elements": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "allowOverride": { "type": "boolean" }, "combinationType": { "type": "string", "minLength": 1 }, "displayOptions": { "type": "number" }, "elementGroups": { "type": "array", "items": { "type": "object" } }, "elementName": { "type": "string", "minLength": 1 }, "elementTimeout": { "type": "number" }, "hideOnNull": { "type": "boolean" }, "hideWarnings": { "type": "boolean" }, "protectedExpression": { "type": "boolean" }, "summarize": { "type": "boolean" }, "formulaExpression": { "type": "string", "minLength": 1 } }, "required": [ "allowOverride", "combinationType", "displayOptions", "elementName", "elementTimeout", "hideOnNull", "hideWarnings", "protectedExpression", "summarize", "formulaExpression" ] } }, "status": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "__PROC": { "type": "object", "required": [ "sourceId", "typeCode", "fsId", "type" ], "properties": { "sourceId": { "type": "string", "minLength": 1 }, "typeCode": { "type": "string", "minLength": 1 }, "fsId": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 } } } } } } } }, "required": [ "data" ] }, "examples": { "generateParameterRequestExample": { "value": { "data": { "targetDate": "2021-12-10", "item": "P0000012345", "testFormula": { "elements": [ { "allowOverride": false, "combinationType": "FUNCTION", "displayOptions": 16, "elementGroups": [], "elementName": "NewElement", "elementTimeout": 0, "hideOnNull": false, "hideWarnings": false, "protectedExpression": false, "summarize": false, "formulaExpression": "api.inputBuilderFactory()\n .createStringUserEntry(\"MyStringParameter\")\n .getInput()" } ], "status": "ACTIVE", "uniqueName": "admin", "validAfter": "2020-01-01", "__PROC": { "sourceId": "CalculationLogic/MichalS+2020-01-01", "typeCode": "F", "fsId": "CalculationLogic/MichalS+2020-01-01", "type": "CalculationLogic" } } } } } } } } }, "tags": [ "Logics" ] } }, "/formulamanager.check": { "post": { "summary": "Syntax Check", "operationId": "post-formulamanager.check", "responses": { "200": { "description": "OK" } }, "description": "Checks syntax for the provided logic fragment. As logic fragments (i.e. calculation schema entries or logic elements) can also reference previous logic element results, the parameter `knownElements` is available to declare a number of “names” as valid for the purpose of the syntax check.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "syntaxCheckRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "formulaExpression", "knownElements" ], "properties": { "formulaExpression": { "type": "string", "minLength": 1, "description": "The expression string of the fragment." }, "knownElements": { "type": "array", "description": "An array of strings with valid element names (which could be referenced in the expression).", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "syntaxCheckRequestExample": { "value": { "data": { "formulaExpression": "api.inputBuilderFactory()\n .createStringUserEntry(\"MyStringParameter\")\n .getInput()", "knownElements": [ "string", "string" ] } } } } } } }, "tags": [ "Logics" ] } }, "/formulamanager.params/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to list parameters for. If omitted, the logic as specified in the product’s master is used, otherwise the passed logic is used." } ], "post": { "summary": "List Logic Parameters (Input Fields)", "operationId": "post-formulamanager.params-uniqueName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listLogicInputFieldsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "object" }, "status": { "type": "integer" } } } } } } } } }, "description": "Retrieves a list of parameters (input fields) and their properties for the specified logic.", "tags": [ "Logics" ] } }, "/formulamanager.libraries": { "post": { "summary": "List Libraries", "operationId": "post-formulamanager.libraries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listLibrariesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Logics" ], "description": "Retrieves active Groovy libraries, including elements and functions." } }, "/formulamanager.executeformula/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to execute." } ], "post": { "summary": "Execute a Logic (Without a Context)", "operationId": "post-formulamanager.executeformula-uniqueName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeLogicWithoutProductContextResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": {}, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Executes a logic and returns results.

\nUse the `output=rawjson` parameter in the URL, for example `/formulamanager.executeformula/QuoteLogic?output=rawjson` in order to return the result in the simple JSON format as `\"resultName\"`:`result`.", "requestBody": { "$ref": "#/components/requestBodies/executeLogic" }, "parameters": [ { "$ref": "#/components/parameters/output" }, { "$ref": "#/components/parameters/templateName" }, { "schema": { "type": "string" }, "in": "query", "name": "fileName", "description": "Sets the name of the output file." } ] } }, "/formulamanager.executeformulaservice/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to execute." } ], "post": { "summary": "Execute a Logic Without a Context in a Service", "operationId": "post-formulamanager.executeformulaservice-uniqueName", "tags": [ "Logics" ], "description": "Executes a logic and returns results.

\nThe main difference between this command and the executeformula command is, that in this **formulamanager.executeformulaservice** command, the logic context is preserved and reused. This allows the formula to build and maintain a cache, as elements like api.global persist between calls.
\nEach thread operates with its own formula context and `api.global` instance. The system maintains a fixed number of service threads, with a predefined lifespan for each. Parallel API requests are queued and executed on these threads in sequence. If a request cannot be processed within a short timeframe, it will fail. For this reason, it is crucial that subsequent requests execute efficiently, leveraging caching whenever possible. Be aware that during long cache warm-up periods (e.g., when new threads are initialized), there is a higher risk of request failures.

\nUse the `output=rawjson` parameter in the URL, for example `/formulamanager.executeformula/QuoteLogic?output=rawjson` in order to return the result in the simple JSON format as `\"resultName\"`:`result`.", "requestBody": { "$ref": "#/components/requestBodies/executeLogic" }, "responses": { "200": { "$ref": "#/components/responses/logicResponse" } } } }, "/formulamanager.executeformula/{uniqueName}/readonly": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to execute." } ], "post": { "summary": "Execute a Logic (Read-Only)", "operationId": "post-formulamanager.executeformula-uniqueName-readonly", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeLogicReadOnlyResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": {}, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Executes the formula with disabled object modification capabilities.

\nUse the `output=rawjson` parameter in the URL, for example `/formulamanager.executeformula/QuoteLogic?output=rawjson` in order to return the result in the simple JSON format as `\"resultName\"`:`result`." } }, "/formulamanager.executeformulaservice/{uniqueName}/readonly": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true, "description": "The name (`uniqueName`) of the logic you want to execute." } ], "post": { "summary": "Execute a Logic Without a Context in a Service (Read-Only)", "operationId": "post-formulamanager.executeformulaservice-uniqueName-readonly", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeLogicReadOnlyResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": {}, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Executes the logic without an explicit product context in a service with disabled object modification capabilities.

\nUse the `output=rawjson` parameter in the URL, for example `/formulamanager.executeformulaservice/QuoteLogic?output=rawjson` in order to return the result in the simple JSON format as `\"resultName\"`:`result`." } }, "/formulamanager.copy/{id}": { "post": { "summary": "Copy a Logic", "operationId": "post-formulamanager.copy-id)", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "copyLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaNature": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "formulaType": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Creates a copy of the specified logic. The `validAfter` value is set to today's date, all other values and sub-elements are exact copies." }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the logic. you want to copy. The `id` is the `typedId` without the **F** suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.F** is **2147484837**." } ] }, "/formulamanager.librarymethods": { "post": { "summary": "List Functions", "operationId": "post-formulamanager.librarymethods", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listFunctionsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Logics" ], "description": "Retrieves a list of functions in an active Groovy library." } }, "/formulamanager.testexec": { "post": { "summary": "Test a Logic", "operationId": "post-formulamanager.testexec", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "elementResultDescription": { "type": "string", "nullable": true }, "traceMessages": { "type": "string", "nullable": true }, "alertMessage": { "type": "string", "nullable": true }, "warnings": { "type": "array", "nullable": true, "items": { "type": "string" } }, "alertType": { "type": "string", "nullable": true }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "nullable": true }, "overridden": { "type": "boolean" }, "overridable": { "type": "boolean" }, "summarize": { "type": "boolean" }, "hideOnNull": { "type": "boolean" }, "hideWarnings": { "type": "boolean" }, "excludeFromExport": { "type": "boolean" }, "userGroup": { "type": "string", "nullable": true }, "resultGroup": { "type": "string", "nullable": true }, "labelTranslations": { "type": "string", "nullable": true }, "suffix": { "type": "string", "nullable": true }, "cssProperties": { "type": "string", "nullable": true }, "cellStyles": { "type": "string", "nullable": true }, "overrideValueOptions": { "type": "string", "nullable": true }, "overrideAllowEmpty": { "type": "boolean" }, "fieldType": { "type": "integer" }, "resultType": { "type": "string" }, "elementResultClass": { "type": "string", "nullable": true }, "elementResult": { "type": "string", "nullable": true } } } }, "status": { "type": "integer" } } } } }, "examples": { "testLogicResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-65c978b8dd-6wgk5", "data": [ { "elementName": "NewElement", "elementLabel": "NewElement", "elementResultDescription": null, "traceMessages": null, "alertMessage": null, "warnings": [ "UserEntry parameter not found: MyStringParameter" ], "alertType": null, "displayOptions": 16, "formatType": null, "overridden": false, "overridable": false, "summarize": false, "hideOnNull": false, "hideWarnings": false, "excludeFromExport": false, "userGroup": null, "resultGroup": null, "labelTranslations": null, "suffix": null, "cssProperties": null, "cellStyles": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "fieldType": 0, "resultType": "SIMPLE", "elementResultClass": null, "elementResult": null }, { "elementName": "__TRACE__", "elementLabel": "__TRACE__", "elementResultDescription": null, "traceMessages": null, "alertMessage": null, "warnings": null, "alertType": null, "displayOptions": 0, "formatType": null, "overridden": false, "overridable": false, "summarize": false, "hideOnNull": false, "hideWarnings": false, "excludeFromExport": false, "userGroup": null, "resultGroup": null, "labelTranslations": null, "suffix": null, "cssProperties": null, "cellStyles": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "fieldType": 2, "resultType": "SIMPLE", "elementResultClass": "java.lang.String", "elementResult": "---------------------------------------------------------\nDuration (ms) Count Execution element\n---------------------------------------------------------\n 599.54 100% ██████████ 1 TestExecute\n 0.26 0% ░░░░░░░░░░ 1 ├── search.Partition\n 2.34 0% ░░░░░░░░░░ 1 ├── search.ApplicationProperties\n 562.31 94% █████████░ 1 └── MichalS\n 0.09 0% ░░░░░░░░░░ 1 ├── POS.flush\n 562.11 94% █████████░ 1 └── NewElement\n 3.10 1% ░░░░░░░░░░ 1 └── search.PricingFormula\n" } ], "status": 0 } } } } } } } }, "tags": [ "Logics" ], "description": "Executes a draft logic for a given approvable and calculates the result. This command is used to test a logic during editing (the \"Test Logic\" button in IntelliJ Pricefx Studio).

\nThe backend will compile and execute the test logic (specified in the `testFormula` property) without persisting it in the database.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "testLogicRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "testFormula" ], "properties": { "targetDate": { "type": "string", "minLength": 1 }, "testFormula": { "$ref": "#/components/schemas/PricingFormula" }, "knownElements": { "type": "array", "items": { "type": "string" } }, "productSKU": { "type": "string" }, "item": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "nature": { "type": "string" }, "natureValue": { "type": "string" }, "headerPhases": { "type": "object" }, "formulaExpression": { "type": "string" }, "allResults": { "type": "boolean" }, "type": { "type": "string" }, "debugPort": { "type": "string" }, "allowObjectMods": { "type": "boolean" }, "selectedRows": { "type": "array", "items": { "type": "string" } }, "formulaFilterParam": { "type": "string" }, "forceLineRecalculation": { "type": "boolean", "description": "Used by PFX Studio for Header logics only." } } } }, "required": [ "data" ] }, "examples": { "testLogicRequestExample": { "value": { "data": { "targetDate": "2021-12-10", "testFormula": { "elements": [ { "allowOverride": false, "combinationType": "FUNCTION", "displayOptions": 16, "elementGroups": [], "elementName": "NewElement", "elementTimeout": 0, "hideOnNull": false, "hideWarnings": false, "protectedExpression": false, "summarize": false, "formulaExpression": "api.inputBuilderFactory()\n .createStringUserEntry(\"MyStringParameter\")\n .getInput()" } ], "status": "ACTIVE", "uniqueName": "MichalS", "validAfter": "2020-01-01", "__PROC": { "sourceId": "CalculationLogic/MichalS+2020-01-01", "typeCode": "F", "fsId": "CalculationLogic/MichalS+2020-01-01", "type": "CalculationLogic" } } } } } } } } } } }, "/add/U": { "post": { "summary": "Add a User", "operationId": "post-add-U", "responses": { "200": { "$ref": "#/components/responses/userResponse" } }, "tags": [ "User Admin" ], "description": "Creates a new user.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addUserRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "loginName", "email" ], "properties": { "loginName": { "type": "string", "minLength": 1 }, "email": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "activated": { "type": "string", "minLength": 1 }, "ssoOnly": { "type": "boolean" }, "defaultUserGroupEdit": { "type": "string", "minLength": 1 }, "defaultUserGroupViewDetails": { "type": "string", "minLength": 1 }, "emailLocale": { "type": "string", "minLength": 1 }, "workflowEmailingActivated": { "type": "string", "minLength": 1 }, "noSession": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "requireTFA": { "type": "boolean" } } }, "operation": { "type": "string", "minLength": 1 } }, "required": [ "data" ] }, "examples": { "addUserRequestExample": { "value": { "data": { "loginName": "tim.smith", "email": "non@existent33.com", "firstName": "Tim", "lastName": "Smith", "activated": "true", "ssoOnly": true, "defaultUserGroupEdit": "Administrators", "defaultUserGroupViewDetails": "Administrators", "emailLocale": "en", "workflowEmailingActivated": "true", "noSession": true, "receiveAdminEmail": true, "requireTFA": true }, "operation": "add" } } } } } } } }, "/update/U": { "post": { "summary": "Update a User", "operationId": "post-update-U", "responses": { "200": { "$ref": "#/components/responses/userResponse" } }, "tags": [ "User Admin" ], "description": "Updates details of the specified user.

\n>**Information**: Note that **Update a User** should not be used for role or group assignments. For these operations, use APIs such as **Assign a Business Role to a User** or **Assign a User Group to Users**.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateUserRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId", "email" ], "properties": { "typedId": { "type": "string", "minLength": 1, "description": "The `typedId` of the user you want to update." }, "email": { "type": "string", "minLength": 1, "description": "The name and a new value of the attribute you want to update." } } }, "oldValues": { "type": "object", "required": [ "version", "typedId", "loginName", "firstName", "lastName", "email", "defaultUserGroupEdit", "defaultUserGroupViewDetails", "roleNames", "allRoleNames", "allGroups", "createDate", "createdBy", "lastUpdateBy", "_key", "_level" ], "description": "Values before the update.", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "loginName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "email": { "type": "string", "minLength": 1 }, "groups": { "type": "array", "items": { "type": "object" } }, "businessRoles": { "type": "array", "items": { "type": "object" } }, "activated": { "type": "boolean" }, "workflowEmailingActivated": { "type": "boolean" }, "noSession": { "type": "boolean" }, "requireTFA": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "ssoOnly": { "type": "boolean" }, "wizardDashboardName": {}, "firstLogin": { "type": "boolean" }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "emailLocale": {}, "defaultUserGroupEdit": { "type": "string", "minLength": 1 }, "defaultUserGroupViewDetails": { "type": "string", "minLength": 1 }, "productFilterCriteria": {}, "customerFilterCriteria": {}, "roleNames": { "type": "array", "items": { "type": "object" } }, "allRoleNames": { "type": "array", "items": { "type": "object" } }, "allGroups": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastLogin": {}, "lastUpdateBy": { "type": "number" }, "extendedData": {}, "passwordExpiry": {}, "_key": { "type": "string", "minLength": 1 }, "_level": { "type": "number" } } }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data", "oldValues" ] }, "examples": { "updateUserRequestExample": { "value": { "data": { "typedId": "2147491062.U", "email": "j.price@pricingacademy.com" }, "oldValues": { "version": 1, "typedId": "2147491062.U", "loginName": "john.pricer", "firstName": "Tim", "lastName": "Smith", "email": "non@existent33.com", "groups": [], "businessRoles": [], "activated": true, "workflowEmailingActivated": true, "noSession": true, "requireTFA": true, "receiveAdminEmail": true, "ssoOnly": true, "wizardDashboardName": null, "firstLogin": false, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "emailLocale": null, "defaultUserGroupEdit": "Administrators", "defaultUserGroupViewDetails": "Administrators", "productFilterCriteria": null, "customerFilterCriteria": null, "roleNames": [], "allRoleNames": [], "allGroups": [], "createDate": "2021-12-12T12:59:07", "createdBy": 2147490696, "lastLogin": null, "lastUpdateBy": 2147490696, "extendedData": null, "passwordExpiry": null, "_key": "2147491062.U", "_level": 0 }, "operationType": "update", "textMatchStyle": "exact" } } } } }, "description": "Specify the user by `typedId` and define the new value of the field you want to update in the `data` object." } } }, "/delete/U": { "post": { "summary": "Delete a User", "operationId": "post-delete-U", "responses": { "200": { "$ref": "#/components/responses/userResponse" } }, "tags": [ "User Admin" ], "description": "Deletes a specified user.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteUserRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteUserRequestExample": { "value": { "data": { "typedId": "2147491062.U" } } } } } } } } }, "/add/MPL": { "post": { "summary": "Create a Manual Price List", "operationId": "post-add-MPL", "responses": { "200": { "$ref": "#/components/responses/manualpricelistResponse" } }, "tags": [ "Manual Price Lists" ], "description": "Creates a Manual Price List object. The Manual Price List is created without products. Use the **/manualpricelistmanager.add/{id}** (Add Products to a Manual Price List) endpoint to add products.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createManualPriceListRequest", "type": "object", "properties": { "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "required": [ "uniqueName", "validAfter", "status" ], "properties": { "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "nodeId": {} } }, "oldValues": {} }, "required": [ "operationType", "textMatchStyle", "data" ] }, "examples": { "createManualPriceListRequestExample": { "value": { "operationType": "add", "textMatchStyle": "exact", "data": { "uniqueName": "MPL01", "label": "The Manual Price List 1", "validAfter": "2021-12-11T14:11:09.060Z", "status": "ACTIVE", "nodeId": null }, "oldValues": null } } } } } } } }, "/manualpricelistmanager.add/{id}/recalculate": { "parameters": [ { "schema": { "type": "string", "example": "22" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List where you want to add products to." } ], "post": { "summary": "Add Products to a Manual Pricelist", "operationId": "post-manualpricelistmanager.add-id-recalculate", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Manual Price Lists" ], "description": "Adds products to the previously created Manual Price List and recalculates the Manual Price List.\n\n>To add items without a recalculation, use the **/manualpricelistmanager.add/{id}\n** endpoint.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addProductsToManualPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "skus" ], "properties": { "skus": { "type": "array", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "addProductsRequestExample": { "value": { "data": { "skus": [ "P00001", "P00002", "P00003" ] } } } } } } } } }, "/manualpricelistmanager.add/{id}": { "parameters": [ { "schema": { "type": "string", "example": "22" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List where you want to add products to." } ], "post": { "summary": "Add Products to a Manual Price List (No Recalculation)", "operationId": "post-manualpricelistmanager.add-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "addProductsToManualPriceListNoRecalcResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "Manual Price Lists" ], "description": "Adds products to the previously created Manual Price List. Use to skip recalculation of `comments` and `manualResultPrice` (Manual Override).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addProductsToManualPriceListNoRecalcRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "skus" ], "properties": { "skus": { "type": "array", "items": { "type": "string" } } } } }, "required": [ "data" ] }, "examples": { "addProductsRequestExample": { "value": { "data": { "skus": [ "P00001", "P00002", "P00003" ] } } } } } } } } }, "/manualpricelistmanager.fetch/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List you want to retrieve products from." } ], "post": { "summary": "List Products From a Manual Price List", "operationId": "post-manualpricelistmanager.fetch-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listProductsFromManualPriceListResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "comments": {}, "pricelistId": { "type": "number" }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {} } } }, "endRow": { "type": "number" } } } } } } } } }, "description": "Retrieves products' details from the specified Manual Price List. A filter can be applied.", "tags": [ "Manual Price Lists" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listProductsFromManualPriceListRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listProductsfromMPLRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "iEquals", "value": "USD" } ] } } } } } } } } }, "/fetch/MPL": { "post": { "summary": "List Manual Price Lists", "operationId": "post-fetch-MPL", "responses": { "200": { "$ref": "#/components/responses/manualpricelistResponse" } }, "tags": [ "Manual Price Lists" ], "description": "Retrieves a list of Manual Price List objects. ", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listManualPriceListsRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listManualPristListsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "equals", "value": "ACTIVE" } ] } } } } } } } } }, "/manualpricelistmanager.massedit/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List whose products you want to update." } ], "post": { "summary": "Mass Edit a Manual Price List Items", "operationId": "post-manualpricelistmanager.massedit-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "massEditManualPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "A single item array with a string that represents the number of rows changed.", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Manual Price Lists" ], "description": "Performs a mass update operation on products in the specified Manual Price List.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "massEditMPLRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "filterCriteria", "massEditRecords" ], "properties": { "filterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "description": "Specify `id`s of the items you want to update.", "items": { "type": "string" } }, "_constructor": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value", "_constructor" ] } } } }, "massEditRecords": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "The name of the field you want to update." }, "massEditOperator": { "type": "string", "minLength": 1, "description": "Can be either one of these valid operators: `+` `-` `*` If omitted, the provided value is set (`=` operator). Otherwise the specified operation is applied." }, "fieldValue": { "type": "string", "minLength": 1, "description": "The new value of the field. If omitted, the field is set to null." }, "precision": {} }, "required": [ "fieldName", "massEditOperator", "fieldValue" ] } } } } }, "required": [ "data" ] }, "examples": { "massEditMPLRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "94", "95" ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "currency", "massEditOperator": "=", "fieldValue": "USD", "precision": null } ] } } } } } } } } }, "/manualpricelistmanager.update/{id}/recalculate": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List whose item you want to update." } ], "post": { "summary": "Update a Manual Price List Item", "operationId": "post-manualpricelistmanager.update-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "updateManualPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "A single item array with a string that represents the number of rows changed.", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Manual Price Lists" ], "description": "Updates an item and recalculates the specified Manual Price List.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateManualPriceListRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "description": "`typedId` of the item (`MPLI`) you want to update." }, "currency": { "type": "string" } } }, "oldValues": { "$ref": "#/components/schemas/ManualPricelistItem" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "data" ] }, "examples": { "updateMPLIRequestExample": { "value": { "data": { "typedId": "111.MPLI", "currency": "USD" }, "oldValues": { "version": 2, "typedId": "111.MPLI", "sku": "B-0003", "label": "Rise of the Phoenix", "unitOfMeasure": "", "currency": "EUR", "comments": null, "pricelistId": 226, "lastUpdateByName": "admin", "createdByName": null, "createDate": "2023-06-02T10:29:21", "createdBy": 2147490696, "lastUpdateDate": "2023-06-02T10:29:21", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "_key": "111.MPLI", "_level": 0 }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/manualpricelistmanager.integrate/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List whose product you want to create or update." } ], "post": { "summary": "Upsert a Product in a Manual Price List", "operationId": "post-manualpricelistmanager.integrate-id", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "tags": [ "Manual Price Lists" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertProductManualPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "comments": { "type": "string", "minLength": 1 } } } }, "required": [ "data" ] }, "examples": { "upsertProductMPLRequestExample": { "value": { "data": { "sku": "P00110101", "label": "tofu", "currency": "USD", "comments": "The final version." } } } } } }, "description": "" }, "description": "Adds or updates a product in the specified Manual Price List.

\nTo *add* a new product that does not exist, specify the `sku` parameter in the request.\n\nTo *update* an existing product, specify the `sku` or `typedId` parameter of the existing product. The /integrate method performs a partial update – it does not delete values from fields that have not been specified in the update request." } }, "/manualpricelistmanager.delete/{id}/batch": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List whose products you want to delete." } ], "post": { "summary": "Delete Products from a Manual Price List", "operationId": "post-manualpricelistmanager.delete-id-batch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteProductsFromManualPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "The number of deleted items.", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "description": "Deletes products specified by filter settings from the Manual Price List.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteProductsFromManualPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "filterCriteria" ], "properties": { "filterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } } } } } }, "required": [ "data" ] }, "examples": { "deleteProductsMPLRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "comments", "operator": "iEquals", "value": "del" } ] } } } } } } } }, "tags": [ "Manual Price Lists" ] } }, "/manualpricelistmanager.delete/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List whose product you want to delete." } ], "post": { "summary": "Delete a Product from a Manual Price List", "operationId": "post-manualpricelistmanager.delete-id", "responses": { "200": { "$ref": "#/components/responses/productResponse" } }, "description": "Deletes a product specified by `typedId` from the Manual Price List.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteProductFromManualPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "minLength": 1, "description": "typedId of the product you want to delete." } } } }, "required": [ "data" ] }, "examples": { "deleteProductMPLRequestExample": { "value": { "data": { "typedId": "96.MPLI" } } } } } } }, "tags": [ "Manual Price Lists" ] } }, "/manualpricelistmanager.delete": { "post": { "summary": "Delete a Manual Price List", "operationId": "post-manualpricelistmanager.delete", "responses": { "200": { "$ref": "#/components/responses/manualpricelistResponse" } }, "tags": [ "Manual Price Lists" ], "description": "Deletes the specified Manual Price List.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteManualPriceListRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "minLength": 1 } } }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 }, "oldValues": {} }, "required": [ "data", "operationType" ] }, "examples": { "deleteManualPriceList": { "value": { "data": { "typedId": "224.MPL" }, "operationType": "remove", "textMatchStyle": "exact", "oldValues": null } } } } } } } }, "/manualpricelistmanager.copy/{id}": { "post": { "summary": "Copy a Manual Price List", "operationId": "post-manualpricelistmanager.copy", "tags": [ "Manual Price Lists" ], "description": "Creates a copy of the specified Manual Price List.", "responses": { "200": { "$ref": "#/components/responses/manualpricelistResponse" } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List you want to copy." } ] }, "/manualpricelistmanager.calculate/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Manual Price List you want to start the calculation for." } ], "post": { "summary": "Calculate a Manual Price List", "operationId": "post-manualpricelistmanager.calculate-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "calculateManualPriceListResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Manual Price Lists" ], "description": "Starts a calculation of the entire Manual Price List.\n>**Please note**:\n>The calculated Manual Price List must contain a value in the `linkedCFStypedId` (CFS Link) field to perform the calculation action." } }, "/massedit/{TypeCode}": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ], "post": { "summary": "Mass Update", "tags": [ "General" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "massUpdateResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "The number of updated records. This number can be different from what the client UI initially thinks because the server takes edit restrictions into account.", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "operationId": "post-massedit-TypeCode", "description": "Performs a mass update operation on the specified object. This operation is not available for all types of objects – `\"massEditable\" = \"true\"` must be set on the object to allow the mass edit operation.
\nSet the filter criteria to restrict the scope of the mass edit operation.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "massUpdateRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "filterCriteria", "massEditRecords" ], "properties": { "filterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "items": { "type": "string" } }, "_constructor": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "_constructor" ] } } } }, "massEditRecords": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "description": "The name of the field you want to update.\n" }, "massEditOperator": { "type": "string", "minLength": 1, "description": "Can be either one of these valid operators: `+` `-` `*` If omitted, the provided value is set (`=` operator). Otherwise the specified operation is applied." }, "fieldValue": { "type": "string", "minLength": 1 }, "precision": { "description": "The new value of the field. If omitted, the field is set to null." } }, "required": [ "fieldName", "massEditOperator", "fieldValue" ] } } } } }, "required": [ "data" ] }, "examples": { "massUpdateRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "2147501189", "2147501188" ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "currency", "massEditOperator": "=", "fieldValue": "USD", "precision": null } ] } } } } } } } } }, "/resetcolumn/{TypeCode}/{columnName}": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." }, { "schema": { "type": "string" }, "name": "columnName", "in": "path", "required": true, "description": "The name of the column/attribute you want to remove values from." } ], "post": { "summary": "Delete Column Values", "operationId": "post-resetcolumn-TypeCode-columnName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteColumnValuesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": {}, "status": { "type": "number" } } } } } } } } }, "tags": [ "General" ], "description": "Removes values from the specified column." } }, "/delete/{TypeCode}/batch/forcefilter": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ], "post": { "summary": "Delete Objects", "operationId": "post-delete-TypeCode-batch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteObjectsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "description": "The number of deleted records.", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "General" ], "description": "Deletes multiple objects based on filter settings.\n\n>**Please Note**:\n>Invalid filter clauses are ignored. This could potentially lead to a full table truncate (the whole type without filter is deleted)! Use the **forcefilter** variant to enforce a filter in all cases!", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteObjectsForceFilterRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "fieldName", "operator", "value" ], "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } }, "required": [ "_constructor", "operator", "criteria" ] } }, "required": [ "filterCriteria" ] } }, "required": [ "data" ] }, "examples": { "deleteObjectsRequestExample": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "currency", "operator": "iEquals", "value": "EUR" } ] } } } } } } } } } }, "/add/{TypeCode}": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ], "post": { "summary": "Create an Object", "operationId": "post-add-TypeCode", "responses": { "200": { "description": "OK" } }, "tags": [ "General" ], "description": "Creates an object. Only one object can be added per request (unless batched).\n\n>**Information**: Some object types may be blocked from being added by the update command as special processing is done by a dedicated manager command.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createObjectRequest", "type": "object", "properties": { "data": { "type": "object", "description": "The initial values of the object. The request needs to contain all fields that are part of the business key for that object and all non-nullable fields." }, "operation": { "type": "string", "minLength": 1, "description": "Must be `add`, null, or omitted." } }, "required": [ "data", "operation" ] }, "examples": { "createNewObjectRequestExample": { "value": { "data": { "sku": "product001", "label": "The Label 99", "currency": "USD", "formulaName": "PriceList", "attribute1": "123", "attribute2": "2" }, "operation": "add" } } } } } } } }, "/fetch/{TypeCode}/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the object you want to retrieve details for." } ], "post": { "summary": "Get an Object", "operationId": "post-fetch-TypeCode-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getObjectResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "string" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "General" ], "description": "Retrieves details of the specified object.\n\n\n>**Note**: Certain data elements (e.g. lookup table values of any table, including JSON lookup tables / pricing params) should NOT be retrieved with the general fetch commands (**/fetch/{TypeCode}**). Always use the \"**...manager.fetch**\" API endpoints where they are available. The same applies to update/delete/integrate commands.\n\n\n>**Information**: The following [entities](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) can intentionally be fetched by any user without any particular [user role](https://pricefx.atlassian.net/wiki/spaces/HELP/pages/3279194862/User+Roles): CN, BR, CS, CLLIAM, CTAM, CTT, CTTAM, C, CAM, CXAM, DMDC, DMF, DMDL, DMDS, DM, DMM, DMR, DMT, DCRAM, FN, IE, JST, JLTVM, MPLIT, MPLAM, MLTVM, MRAM, MT, PYRAM, PGIM, PRAM, PLIM, P, PAM, PXAM, QAM, RBAAM, RRAM, RRS, RRSC, RBT, RBTAM, SC, SCN, SCNAM, SIM, SIAM, UG." } }, "/fetch/{TypeCode}": { "parameters": [ { "schema": { "type": "string" }, "name": "TypeCode", "in": "path", "required": true, "description": "The object's type code. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes)." } ], "post": { "summary": "List Objects", "operationId": "post-fetch-TypeCode", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "description": "Retrieves all objects (including details) of the specified type. A [filter](https://api.pricefx.com/rest-api/filtering-sorting-pagination/#advanced-filtering) can be applied.\n\n\n>**Information**: Certain data elements (e.g. lookup table values of any table, including JSON lookup tables / pricing params) should NOT be retrieved with the general fetch commands (**/fetch/{TypeCode}**). Always use the \"**...manager.fetch**\" API endpoints where they are available. The same applies to update/delete/integrate commands.\n\n\n>**Information**: The following [entities](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) can intentionally be fetched by any user without any particular [user role](https://pricefx.atlassian.net/wiki/spaces/HELP/pages/3279194862/User+Roles): CN, BR, CS, CLLIAM, CTAM, CTT, CTTAM, C, CAM, CXAM, DMDC, DMF, DMDL, DMDS, DM, DMM, DMR, DMT, DCRAM, FN, IE, JST, JLTVM, MPLIT, MPLAM, MLTVM, MRAM, MT, PYRAM, PGIM, PRAM, PLIM, P, PAM, PXAM, QAM, RBAAM, RRAM, RRS, RRSC, RBT, RBTAM, SC, SCN, SCNAM, SIM, SIAM, UG.\n\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Product](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)'s **listProductsResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Product](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)'s **listProductsResponseExample_valueFields** response example.", "tags": [ "General" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "operationType": { "type": "string" }, "startRow": { "type": "integer", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "enum": [ "startsWith", "exact", "substring" ], "default": "exact" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string", "description": "Specify an operator of the filter criteria.", "enum": [ "equals", "iEquals", "notEqual", "iNotEqual", "greaterThan", "greaterOrEqual", "lessOrEqual", "lessThan", "isNull", "notNull", "contains", "iContains", "containsPattern", "iContainsPattern", "notContains", "iNotContains", "startsWith", "iStartsWith", "notStartsWith", "iNotStartsWith", "endsWith", "iEndsWith", "notEndsWith", "iNotEndsWith", "iBetween", "iBetweenInclusive", "inSet", "notInSet" ] }, "value": { "type": "string" } } } } } } } }, "examples": { "listObjectsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "expiryDate", "operator": "lessThan", "value": "2023-05-25" } ] } } } } }, "application/xml": { "schema": { "type": "object", "properties": {} } }, "multipart/form-data": { "schema": { "type": "object", "properties": {} } } } } } }, "/fetch": { "post": { "summary": "List Type Codes", "operationId": "post-fetch", "responses": { "200": { "$ref": "#/components/responses/typecodesResponse" }, "201": { "description": "Created" } }, "tags": [ "General" ], "description": "Returns the list of all Type Codes." } }, "/customermanager.assign": { "post": { "summary": "Assign Customers", "operationId": "post-customermanager.assign", "responses": { "200": { "$ref": "#/components/responses/assignmentResponse" } }, "tags": [ "Customers", "Live Price Grids", "Manual Price Lists", "Price Lists" ], "description": "Assigns multiple customers to the specified entity (e.g., Price List, Live Price Grid, etc.).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "assignCustomersRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "priority", "assignment" ], "properties": { "customerGroup": { "type": "object", "properties": { "customerFilterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "Specify customers you want to assign by the filter settings (`fielName`:`value`)", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1, "default": "customerId" }, "operator": { "type": "string", "minLength": 1, "default": "inSet" }, "value": { "type": "array", "description": "Specify `customerId`s of customers you want to assign.", "items": { "type": "string" } } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "criteria" ] }, "label": { "type": "string", "minLength": 1, "description": "The label of the customer assignment." } }, "required": [ "label" ] }, "priority": { "type": "number" }, "assignment": { "type": "string", "minLength": 1, "description": "The `typedId` of the entity you want to assign customers to.", "example": "211.PG" } } }, "operation": { "type": "string", "minLength": 1, "default": "add" } }, "required": [ "data", "operation" ] }, "examples": { "assignCustomerRequestExample": { "value": { "data": { "customerGroup": { "customerFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "customerId", "operator": "inSet", "value": [ "00002", "00003" ] } ] }, "label": "00002,00003" }, "priority": 1, "assignment": "211.PG" }, "operation": "add" } } } } } } } }, "/customermanager.fetchassignments/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147490405.PL" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the entity you want to retrieve assignments for." } ], "post": { "summary": "List Customer Assignments", "operationId": "post-customermanager.fetchassignments-typedId", "responses": { "200": { "$ref": "#/components/responses/assignmentResponse" } }, "tags": [ "Customers", "Live Price Grids", "Price Lists", "Manual Price Lists" ], "description": "Retrieves a list of customers assigned to the specified entity. A filter can be applied (see the request sample).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listCustomerAssignmentsRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "required": [ "_constructor" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "number" } }, "required": [ "operator" ] } } } } } }, "examples": { "listCustomerAssignments": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "priority", "operator": "equals", "value": 2 } ] } } } } } } } } }, "/fetch/C/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The ID of the Customer you want to retrieve details for. The `id` is the `typedId` without the **C** suffix. For example, the `id` parameter of the item with `typedId` = **2147492200.C** is **2147492200**." } ], "post": { "summary": "Get a Customer", "operationId": "post-fetch-C-id", "responses": { "200": { "$ref": "#/components/responses/customerResponse" } }, "tags": [ "Customers" ], "description": "Retrieves details (attributes) of the specified customer." } }, "/rebateagreement.fetch/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "R-2147483871" }, "name": "uniqueName", "in": "path", "required": true, "description": "The `uniqueName` of the Rebate Agreement you want to retrieve details for." } ], "post": { "summary": "Get a Rebate Agreement", "operationId": "post-rebateagreement.fetch-uniqueName", "responses": { "200": { "$ref": "#/components/responses/rebateagreementResponse" } }, "description": "Retrieves details of the specified Rebate Agreement.", "tags": [ "Rebate Agreements" ] } }, "/rebateagreement.additems": { "post": { "summary": "Add Rebate Agreement Items", "operationId": "post-rebateagreement.additems", "responses": { "200": { "$ref": "#/components/responses/rebateagreementResponse" } }, "tags": [ "Rebate Agreements" ], "description": "Adds items to the specified Rebate Agreement.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "getCustomerRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "rebateAgreement": { "type": "object", "required": [ "typedId", "uniqueName", "targetDate", "workflowStatus", "lineItems" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": {}, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "seller": {}, "customerGroup": {}, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "payoutDate": { "type": "string", "minLength": 1 }, "rebateRecordSetId": {}, "rebateRecordSetLabel": {}, "simulationSet": {}, "simulationType": {}, "status": { "type": "string", "minLength": 1 }, "rebateAgreementStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": {}, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 }, "headerRebateType": {}, "sellerName": {} } }, "parent": {}, "rebateTypes": { "type": "array", "items": { "type": "string" } } } } } }, "examples": { "addRebateAgreementItemsRequestExample": { "value": { "data": { "rebateAgreement": { "version": 6, "typedId": "2147483857.RBA", "uniqueName": "R-2147483857", "label": "New Rebate Agreement", "targetDate": "2021-10-19", "workflowStatus": "DRAFT", "headerText": null, "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "ondrej.tesar", "createdByName": "ondrej.tesar", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "seller": null, "customerGroup": null, "startDate": "2021-10-19", "endDate": "2021-10-19", "payoutDate": "2021-10-19", "rebateRecordSetId": null, "rebateRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "rebateAgreementStatus": "DRAFT", "renderInfo": null, "serverMessagesExtended": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2021-10-19T11:27:13", "createdBy": 2147483751, "lastUpdateDate": "2021-10-19T11:27:13", "lastUpdateBy": 2147483751, "supersededBy": null, "prevRev": null, "rootUniqueName": "R-2147483857", "headerRebateType": null, "sellerName": null }, "parent": null, "rebateTypes": [ "Rebates" ] } } } } } } } } }, "/delete/RBA": { "post": { "summary": "Delete a Rebate Agreement", "operationId": "post-delete-RBA", "responses": { "200": { "$ref": "#/components/responses/rebateagreementResponse" } }, "tags": [ "Rebate Agreements" ], "description": "Deletes a Rebate Agreement.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteRebateAgreementRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteRebateAgreementRequestExample": { "value": { "data": { "typedId": "2147483846.RBA" } } } } } } } } }, "/alive": { "get": { "summary": "Ping (without authentication)", "tags": [ "Admin Tools" ], "responses": { "200": { "description": "OK - Partition is exists." }, "400": { "description": "Partition does not exist or was deleted." } }, "operationId": "get-alive", "description": "Checks the existence of the partition. No authentication is required." } }, "/clicmanager.fetchheader/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "127.CT" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Contract, Quote, or Rebate Agreement you want to return details for." } ], "post": { "summary": "Get a Quote/Contract/Rebate Agreement/Compensation Plan Header", "operationId": "post-clicmanager.fetchheader-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getQuoteContractRebateAgreementResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Clicmanager", "Contracts (Agreements & Promotions)", "Quotes", "Sales Compensations", "Rebate Agreements" ], "description": "Retrieves details of the specified Compensation Plan, Contract, Quote, or Rebate Agreement - *without line items*.\n

\n\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.\n\n\n\n>Use the **clicmanager.fetch/{typedId}** endpoint to return line items of the specified entity." } }, "/clicmanager.submit/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "127.CT" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Contract, Quote, or Rebate Agreement you want to submit." } ], "post": { "summary": "Submit a Quote/Contract/Rebate Agreement", "operationId": "post-clicmanager.submit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "submitQuoteContractRebateAgreementResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": { "type": "object", "properties": { "customerFieldName": { "type": "string", "minLength": 1 }, "customerFieldValue": { "type": "string", "minLength": 1 }, "customerFieldLabel": { "type": "string" }, "label": { "type": "string", "minLength": 1 } } }, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "properties": {} } }, "parameterConfig": { "type": "object", "properties": {} }, "formattingOptions": { "type": "object", "properties": {} }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "properties": {} } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": { "properties": {} } }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "customerGroup": {}, "productGroup": {}, "externalRef": {}, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "approvedByName": { "type": "string", "minLength": 1 }, "deniedByName": {}, "renderInfo": {}, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "message" ], "properties": { "key": {}, "message": { "type": "string", "minLength": 1 } } } }, "approvalRequiredEmailAttachmentsJson": { "type": "string", "minLength": 1 }, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Clicmanager", "Contracts (Agreements & Promotions)" ], "description": "Submits a Contract, Quote, or Rebate Agreement.\n

\n\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.\n", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "submitQuoteContractRebateAgreementRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "approvalRequiredEmailAttachments": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "items": { "type": "object" } }, "_constructor": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "submitClicRequestExample": { "value": { "data": { "approvalRequiredEmailAttachments": [ { "fieldName": "id", "operator": "inSet", "value": [], "_constructor": "AdvancedCriteria" } ] } } } } } } } } }, "/contractmanager.fetch/{uniqueName}": { "parameters": [ { "schema": { "type": "string", "example": "C-999" }, "name": "uniqueName", "in": "path", "required": true, "description": "`uniqueName` of the Contract you want to retrieve details for. Alternatively, `typedId` can be also used." } ], "post": { "summary": "Get a Contract", "operationId": "post-contractmanager.fetch-uniqueName", "responses": { "200": { "$ref": "#/components/responses/contractModelResponse" } }, "tags": [ "Contracts (Agreements & Promotions)" ], "description": "Retrieves details of the specified Contract." } }, "/contractmanager.additems": { "post": { "summary": "Add Contract Line Items", "operationId": "post-contractmanager.additems", "responses": { "200": { "$ref": "#/components/responses/contractModelResponse" } }, "tags": [ "Contracts (Agreements & Promotions)" ], "description": "Adds line items and recalculates the Contract.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addContractLineItemsRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string" }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": { "type": "string", "minLength": 1 }, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": {}, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "customerGroup": {}, "productGroup": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "productFieldName": {}, "productFieldLabel": {}, "productFieldValue": {}, "productFilterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "operator" ] } }, "operator": { "type": "string", "minLength": 1 } } } } }, "externalRef": {}, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": {}, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "renderInfo": {}, "serverMessagesExtended": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 } } }, "parent": { "type": "string", "minLength": 1 }, "contractTermTypes": { "type": "array", "items": { "type": "object" } } } } } } } } } } }, "/contractmanager.save": { "post": { "summary": "Upsert a Contract", "operationId": "post-contractmanager.save", "responses": { "200": { "$ref": "#/components/responses/contractModelResponse" } }, "tags": [ "Contracts (Agreements & Promotions)" ], "description": "Creates or updates a Contract. To update a Contract, specify an existing `uniqueName`.\n>This endpoint is not allowed to modify the document status and workflow status.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "upsertContractRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "contract": { "type": "object", "properties": { "version": {}, "typedId": {}, "uniqueName": {}, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "properties": {} } }, "parameterConfig": { "type": "object", "properties": {} }, "formattingOptions": { "type": "object", "properties": {} }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "openFolders": { "type": "array", "items": { "properties": {} } }, "gridViewState": { "type": "string", "minLength": 1 }, "selectedNodes": { "type": "array", "items": { "properties": {} } } } }, "outputs": { "type": "array", "items": { "properties": {} } }, "lastUpdateByName": {}, "createdByName": {}, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": { "properties": {} } }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": {}, "typedId": {}, "clicId": {}, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "properties": {} } }, "parameterConfig": { "type": "object", "properties": { "dataType": { "type": "string", "minLength": 1 } } }, "formattingOptions": { "type": "object", "properties": {} }, "valueOptions": {}, "inheritedValue": {} } } }, "outputs": { "type": "array", "items": { "properties": {} } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "startDate": {}, "endDate": {}, "priceRecordId": {}, "customerGroup": {}, "productGroup": { "type": "object", "properties": { "label": {}, "productFieldName": { "type": "string", "minLength": 1 }, "productFieldLabel": { "type": "string", "minLength": 1 }, "productFieldValue": { "type": "string", "minLength": 1 }, "productFilterCriteria": {} } }, "calculationBaseJson": { "type": "string", "minLength": 1 }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "properties": {} } }, "includedProductGroups": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "label": {}, "productFieldName": { "type": "string", "minLength": 1 }, "productFieldLabel": { "type": "string", "minLength": 1 }, "productFieldValue": { "type": "string", "minLength": 1 }, "productFilterCriteria": {} } } }, "includedSellerReferences": { "type": "array", "items": { "properties": {} } }, "excludedCustomerGroups": { "type": "array", "items": { "properties": {} } }, "excludedproductGroups": { "type": "array", "items": { "properties": {} } }, "excludedSellerReferences": { "type": "array", "items": { "properties": {} } }, "includedTimePeriods": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "timeUnit": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "properties": {} } }, "otherFilters": { "type": "array", "items": { "properties": {} } }, "dateDimFieldName": { "type": "string", "minLength": 1 } } }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "contractTermType": { "type": "string", "minLength": 1 } } } }, "customerGroup": {}, "productGroup": { "type": "object", "properties": { "label": {}, "productFieldName": { "type": "string", "minLength": 1 }, "productFieldLabel": { "type": "string", "minLength": 1 }, "productFieldValue": { "type": "string", "minLength": 1 }, "productFilterCriteria": {} }, "required": [ "productFieldName", "productFieldLabel", "productFieldValue" ] }, "externalRef": {}, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "message" ], "properties": { "key": {}, "message": { "type": "string", "minLength": 1 } } } }, "hasWorkflowHistory": { "type": "boolean" }, "renderInfo": {}, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachmentsJson": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": {} }, "required": [ "label", "targetDate", "workflowStatus", "headerText", "inputs", "viewState", "outputs", "calculationStatus", "dirty", "refreshInputs", "nodeId", "serverMessages", "numberOfAttachments", "lineItems", "productGroup", "contractStatus", "startDate", "endDate", "status", "serverMessagesExtended", "hasWorkflowHistory", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ] } }, "required": [ "contract" ] } }, "required": [ "data" ] }, "examples": { "upsertContractRequestExample": { "value": { "data": { "contract": { "version": null, "typedId": null, "uniqueName": null, "label": "New Agreement & Promotion", "targetDate": "2022-01-04", "workflowStatus": "DRAFT", "headerText": "header text", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": { "productFieldName": "sku", "productFieldLabel": "ProductID", "productFieldValue": "B-0002" }, "valueHint": "B-0002 (ProductID)", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "openFolders": [ "ROOT" ], "gridViewState": "({field:[{name:\"CLITN_Status\",frozen:true,width:25},{name:\"CLITN_Status1\",frozen:true,width:25},{name:\"dirtyField\",frozen:true,width:25},{name:\"CLITN_Desc\",frozen:true},{name:\"label\"},{name:\"customerGroup\",visible:false},{name:\"productGroup\",visible:false},{name:\"INPUT_Discount__\",visible:false},{name:\"OUTPUT_CustomerGroup\",visible:false},{name:\"OUTPUT_ProductGroup\",visible:false},{name:\"OUTPUT_StandardDiscount\",visible:false}]})", "selectedNodes": [ "1OVM0Hxdn1zeLjN" ] }, "outputs": [], "lastUpdateByName": null, "createdByName": null, "submittedByName": null, "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Agreements & Promotions calculated successfully" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": null, "typedId": null, "clicId": null, "inputs": [ { "name": "Discount %", "label": "Discount %", "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": { "dataType": "float" }, "formattingOptions": {}, "valueOptions": null, "inheritedValue": null }, { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null, "inheritedValue": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null, "inheritedValue": null } ], "outputs": [], "dirty": false, "lineId": "1OVM0Hxdn1zeLjN", "parentId": null, "calculationStatus": 2, "editabilityStatus": 0, "label": "Promotion Discount", "startDate": null, "endDate": null, "priceRecordId": null, "customerGroup": null, "productGroup": { "label": null, "productFieldName": "sku", "productFieldLabel": "ProductID", "productFieldValue": "B-0002", "productFilterCriteria": null }, "calculationBaseJson": "{\"includedCustomerGroups\":[],\"includedProductGroups\":[{\"productFieldName\":\"sku\",\"productFieldLabel\":\"ProductID\",\"productFieldValue\":\"B-0002\"}],\"includedSellerReferences\":[],\"excludedCustomerGroups\":[],\"excludedproductGroups\":[],\"excludedSellerReferences\":[],\"includedTimePeriods\":[{\"timeUnit\":\"DAY\",\"startDate\":\"2022-01-04\",\"endDate\":\"2022-01-04\",\"single\":false}],\"excludedTimePeriods\":[],\"otherFilters\":[],\"dateDimFieldName\":\"\"}", "calculationBase": { "includedCustomerGroups": [], "includedProductGroups": [ { "label": null, "productFieldName": "sku", "productFieldLabel": "ProductID", "productFieldValue": "B-0002", "productFilterCriteria": null } ], "includedSellerReferences": [], "excludedCustomerGroups": [], "excludedproductGroups": [], "excludedSellerReferences": [], "includedTimePeriods": [ { "timeUnit": "DAY", "startDate": "2022-01-04", "endDate": "2022-01-04", "single": false } ], "excludedTimePeriods": [], "otherFilters": [], "dateDimFieldName": "" }, "folder": false, "treeLabel": "Promotion Discount", "createDate": "2022-01-04T15:00:47", "createdBy": 2147490187, "lastUpdateDate": "2022-01-04T15:00:47", "lastUpdateBy": 2147490187, "contractTermType": "test" } ], "customerGroup": null, "productGroup": { "label": null, "productFieldName": "sku", "productFieldLabel": "ProductID", "productFieldValue": "B-0002", "productFilterCriteria": null }, "externalRef": null, "contractStatus": "DRAFT", "startDate": "2022-01-04", "endDate": "2022-01-04", "status": "DRAFT", "serverMessagesExtended": [ { "key": null, "message": "Agreements & Promotions calculated successfully" } ], "hasWorkflowHistory": false, "renderInfo": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachmentsJson": null, "createDate": "2022-01-04T15:00:47", "createdBy": 2147490187, "lastUpdateDate": "2022-01-04T15:00:47", "lastUpdateBy": 2147490187, "supersededBy": null, "prevRev": null, "rootUniqueName": null } } } } } } } } } }, "/add/AI": { "post": { "summary": "Create an Action Item", "operationId": "post-add-AI", "description": "Adds an Action Item.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "addActionItemRequest", "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ActionItem" } }, "required": [ "data" ] }, "examples": { "addActionItemRequestExample": { "value": { "data": { "summary": "Important Action", "assignedTo": 2147490696, "dueDate": "2023-06-30T00:00:00", "description": "This action is really important!", "actionItemType": "__DEFAULT__", "parentTypedId": null } } } } } }, "description": "" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addActionItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItem" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Actions" ] } }, "/delete/AI": { "post": { "summary": "Delete an Action Item", "operationId": "post-delete-AI", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteActionItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItem" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteActionItemResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ { "version": 1, "typedId": "64.AI", "createdByName": null, "assignedTo": 2147490696, "assignedToName": "admin", "assignedToGroup": null, "description": "description 12", "dueDate": "3923-09-15T00:00:00", "completedDate": null, "lastUpdateByName": null, "summary": "summary 12", "completedBy": null, "completedByName": null, "parentTypedId": null, "parentTabName": null, "originatorTypedId": null, "sourceContext": null, "targetContext": null, "outputs": [], "status": "OPEN", "uniqueName": "AI-64", "createDate": "2023-06-15T12:38:38", "createdBy": 2147490696, "lastUpdateDate": "2023-06-15T12:38:38", "lastUpdateBy": 2147490696, "actionItemType": "__DEFAULT__" } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteActionItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteActionItemRequestExample": { "value": { "data": { "typedId": "42.AI" } } } } } } }, "description": "Deletes an Action Item.", "tags": [ "Actions" ] } }, "/fetch/AI": { "post": { "summary": "List Action Items", "operationId": "post-fetch-AI", "description": "Retrieves Action Items by filter criteria. To retrieve a specific action, filter the action by `id` as follows:\n\n```json\n{\n \"data\":{\n \"fieldName\":\"id\",\n \"operator\":\"equals\",\n \"value\":\"41\",\n \"_constructor\":\"AdvancedCriteria\"\n }\n}\n```\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "_constructor": { "type": "string" } } } } }, "examples": { "listActionItemsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "assignedTo", "operator": "equals", "value": 2147491061 } ] }, { "fieldName": "parentTypedId", "operator": "equals", "value": "90.Q", "_constructor": "AdvancedCriteria" } ] } } } } } } }, "tags": [ "Actions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listActionItemsResponse", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItem" } }, "endRow": { "type": "integer" } } } } } } } } } } }, "/update/AI": { "post": { "summary": "Update an Action Item", "operationId": "post-update-AI", "description": "Updates an existing Action Item.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "updateActionItemRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "description": "`data` should contain the `typedId` of the Action Item you want to update and the updated field.", "properties": { "assignedTo": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 } } }, "oldValues": { "type": "object", "required": [ "version", "typedId" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "assignedTo": { "type": "number" }, "assignedToName": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "dueDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "summary": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "parentTypedId": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } }, "operationType": { "type": "string", "minLength": 1 }, "textMatchStyle": { "type": "string", "minLength": 1 } }, "required": [ "data", "oldValues" ] }, "examples": { "updateActionItemRequestExample": { "value": { "data": { "typedId": "70.AI", "assignedTo": 2147490806 }, "oldValues": { "version": 2, "typedId": "70.AI", "createdByName": "admin", "assignedTo": 2147490696, "assignedToName": "admin", "description": "This action is really important!", "dueDate": "2023-06-30T00:00:00", "lastUpdateByName": "admin", "summary": "Important Action2", "outputs": [], "status": "OPEN", "uniqueName": "AI-70", "createDate": "2023-06-27T12:59:15", "createdBy": 2147490696, "lastUpdateDate": "2023-06-27T12:59:15", "lastUpdateBy": 2147490696, "actionItemType": "__DEFAULT__", "_key": "70.AI", "_level": 0 }, "operationType": "update", "textMatchStyle": "exact" } } } } } }, "tags": [ "Actions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateActionItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItem" } }, "status": { "type": "integer" } } } } }, "examples": { "updateActionItemResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ { "version": 3, "typedId": "70.AI", "createdByName": "admin", "assignedTo": 2147490806, "assignedToName": "userloser", "assignedToGroup": null, "description": "This action is really important!", "dueDate": "2023-06-30T00:00:00", "completedDate": null, "lastUpdateByName": "admin", "summary": "Important Action2", "completedBy": null, "completedByName": null, "parentTypedId": null, "parentTabName": null, "originatorTypedId": null, "sourceContext": null, "targetContext": null, "outputs": [], "status": "OPEN", "uniqueName": "AI-70", "createDate": "2023-06-27T12:59:15", "createdBy": 2147490696, "lastUpdateDate": "2023-06-27T13:02:46", "lastUpdateBy": 2147490696, "actionItemType": "__DEFAULT__" } ], "status": 0 } } } } } } } } } }, "/productmanager.fetch/*/PX/{ProductMasterExtensionName}": { "parameters": [ { "schema": { "type": "string" }, "name": "ProductMasterExtensionName", "in": "path", "required": true, "description": "Enter the name of Product Extension you want to retrieve objects from. You can find the name in **Administration** > **Configuration** > **Master Data** > **Product Master Extension** or using the **/configurationmanager.get/productextension** endpoint." } ], "post": { "summary": "List Product Extension Objects", "operationId": "post-productmanager.fetch-*-TypeCode", "responses": { "200": { "$ref": "#/components/responses/ProductExtensionResponse" } }, "tags": [ "Product Extensions" ], "description": "Retrieves records from the Product Extensions table.

\nExport the table to the Excel file (XLSX), CSV, or JSON using the `output` URL query parameter. When exporting to the file, specify fields (within the `resultFields` property) you want to include in the output table.

\nExample request body for the export action:\n```json\n{\n \"data\":{\n \"criteria\":[\n\n ],\n \"operator\":\"and\"\n },\n \"resultFields\":[\n \"sku\",\n \"lastUpdateDate\",\n \"attribute1\"\n ],\n \"valueFields\":[\n\n ]\n}\n```\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Products](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)' **listProductsResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Products](https://api.pricefx.com/openapi/reference/pricefx/operation/post-productmanager.fetchformulafilteredproducts/)' **listProductsResponseExample_valueFields** response example.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listProductExtensionObjectsRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } }, "sortBy": { "type": "array", "items": { "type": "object" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/output" }, { "$ref": "#/components/parameters/useColumnNames" } ] } }, "/customermanager.fetch/*/CX/{CustomerMasterExtensionName}": { "parameters": [ { "schema": { "type": "string" }, "name": "CustomerMasterExtensionName", "in": "path", "required": true, "description": "Enter the name of Customer Extension you want to retrieve objects from. You can find the name in **Administration** > **Configuration** > **Master Data** > **Customer Master Extension** or using the **/configurationmanager.get/customerextension** endpoint." } ], "post": { "summary": "List Customer Extension Objects", "operationId": "post-customermanager.fetch-*-TypeCode", "description": "Retrieves records from the Customer Extensions table.

\nExport the table to the Excel file (XLSX), CSV, or JSON using the `output` URL query parameter. When exporting to the file, specify fields (within the `resultFields` property) you want to include in the output table.

\nExample request body for the export action:\n```json\n{\n \"data\":{\n \"criteria\":[\n\n ],\n \"operator\":\"and\"\n },\n \"resultFields\":[\n \"customerId\",\n \"lastUpdateDate\",\n \"attribute1\"\n ],\n \"valueFields\":[\n\n ]\n}\n```\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_valueFields** response example.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listCustomerExtensionObjectsRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } }, "sortBy": { "type": "array", "items": { "type": "object" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/output" }, { "$ref": "#/components/parameters/useColumnNames" } ], "tags": [ "Customer Extensions" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCustomerExtensionObjectsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CX3" }, { "$ref": "#/components/schemas/CX6" }, { "$ref": "#/components/schemas/CX8" }, { "$ref": "#/components/schemas/CX10" }, { "$ref": "#/components/schemas/CX20" }, { "$ref": "#/components/schemas/CX30" }, { "$ref": "#/components/schemas/CX50" } ] } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listCustomerExtensionObjects": { "value": { "response": { "node": "pricefx-cluster-app-frontend-cb48f6447-qncxw", "data": [ { "version": 0, "typedId": "1.CX3", "name": "CustomerClass", "customerId": "CD-0001", "createDate": "2018-03-13T12:21:21", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:21:21", "lastUpdateBy": 2147483649, "attribute1": "High", "attribute2": "15 %", "attribute3": null }, { "version": 0, "typedId": "2.CX3", "name": "CustomerClass", "customerId": "CD-0002", "createDate": "2018-03-13T12:21:34", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:21:34", "lastUpdateBy": 2147483649, "attribute1": "High", "attribute2": "17 %", "attribute3": null }, { "version": 0, "typedId": "3.CX3", "name": "CustomerClass", "customerId": "CD-0003", "createDate": "2018-03-13T12:21:47", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:21:47", "lastUpdateBy": 2147483649, "attribute1": "Low", "attribute2": "4 %", "attribute3": null }, { "version": 0, "typedId": "4.CX3", "name": "CustomerClass", "customerId": "CD-0004", "createDate": "2018-03-13T12:22:00", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:22:00", "lastUpdateBy": 2147483649, "attribute1": "High", "attribute2": "15 %", "attribute3": null }, { "version": 0, "typedId": "5.CX3", "name": "CustomerClass", "customerId": "CD-0005", "createDate": "2018-03-13T12:22:12", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:22:12", "lastUpdateBy": 2147483649, "attribute1": "Medium", "attribute2": "10 %", "attribute3": null }, { "version": 0, "typedId": "6.CX3", "name": "CustomerClass", "customerId": "CD-0006", "createDate": "2018-03-13T12:22:22", "createdBy": 2147483649, "lastUpdateDate": "2018-03-13T12:22:22", "lastUpdateBy": 2147483649, "attribute1": "Medium", "attribute2": "10 %", "attribute3": null }, { "version": 0, "typedId": "14.CX3", "name": "CustomerClass", "customerId": "CD-0020", "createDate": "2019-10-25T12:10:55", "createdBy": 2147483668, "lastUpdateDate": "2019-10-25T12:10:55", "lastUpdateBy": 2147483668, "attribute1": "Low", "attribute2": "10 %", "attribute3": null } ], "endRow": 7, "totalRows": 7, "status": 0 } } } } } } } } } }, "/contractmanager.submit": { "post": { "summary": "Submit a Contract", "tags": [ "Contracts (Agreements & Promotions)" ], "responses": { "200": { "$ref": "#/components/responses/contractModelResponse" } }, "operationId": "post-contractmanager.submit", "description": "Submits the Contract.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "submitContractRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "contract" ], "properties": { "contract": { "type": "object", "required": [ "version", "typedId", "uniqueName" ], "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string" }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": {}, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "customerGroup": {}, "productGroup": {}, "externalRef": {}, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "approvedByName": {}, "deniedByName": {}, "renderInfo": {}, "serverMessagesExtended": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 } } } } } }, "required": [ "data" ] }, "examples": { "submitContractRequestExample": { "value": { "data": { "contract": { "version": 3, "typedId": "170.CT", "uniqueName": "C-170", "label": "New Agreement & Promotion", "targetDate": "2021-11-18", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "customerGroup": null, "productGroup": null, "externalRef": null, "contractStatus": "DRAFT", "startDate": "2021-11-18", "endDate": "2021-11-18", "status": "DRAFT", "approvedByName": null, "deniedByName": null, "renderInfo": null, "serverMessagesExtended": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2021-11-18T15:48:25", "createdBy": 2147490696, "lastUpdateDate": "2021-11-18T15:48:25", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "C-170" } } } } } } } } } }, "/optimization.modelcalcexec/{typedId}/{stepName}": { "parameters": [ { "schema": { "type": "string", "example": "123.MO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to recalculate the step for." }, { "schema": { "type": "string", "example": "definition", "enum": [ "definition", "configuration", "results", "projections", "parallel" ] }, "name": "stepName", "in": "path", "required": true, "description": "Enter the name of the step you want to calculate." } ], "post": { "summary": "Calculate a Model Object Step", "operationId": "post-optimization.modelcalcexec-typedId-stepName", "tags": [ "Optimization" ], "description": "Executes a calculation of the step as a background task in the context of the Model Object. Returns two elements within the `data` array – the JST (Job Status Tracker) object (the calculation status of the newly created calculation) and the updated ModelObject object.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string" }, "totalJobsCount": { "type": "integer" }, "jobs": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "processingNode": { "type": "integer", "nullable": true }, "threadId": { "type": "integer", "nullable": true }, "threadUUID": { "type": "integer", "nullable": true }, "status": { "type": "string" }, "trackerType": { "type": "string" }, "targetObject": { "type": "string" }, "jobName": { "type": "string" }, "concurrencyKey": { "type": "string" }, "calculationContext": { "type": "string" }, "progress": { "type": "integer", "nullable": true }, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "integer" }, "priority": { "type": "integer" }, "messages": { "type": "string", "nullable": true }, "jobSettings": { "type": "object", "properties": { "distributedAction": { "type": "string", "nullable": true }, "jobType": { "type": "string" }, "uuid": { "type": "string" }, "calculableObjectTypedId": { "type": "string" }, "queueName": { "type": "string", "nullable": true }, "runNumber": { "type": "integer" }, "partitionName": { "type": "string" }, "partitionUUID": { "type": "string" }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "integer" }, "distributed": { "type": "boolean" } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "calculationResults": { "type": "integer", "nullable": true }, "processingStart": { "type": "integer", "nullable": true }, "processingEnd": { "type": "integer", "nullable": true }, "id": { "type": "integer" } } } }, "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "modelClassUN": { "type": "string" }, "currentStep": { "type": "string" }, "state": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "scope": { "type": "object", "properties": { "Scope": { "type": "object", "properties": { "ProductGroups": { "type": "array", "items": { "type": "object" } }, "CustomerGroups": { "type": "array", "items": { "type": "object" } }, "ProductMinRevenue": { "type": "integer", "nullable": true }, "CustomerMinRevenue": { "type": "integer", "nullable": true }, "ProductMinMarginPercent": { "type": "integer", "nullable": true }, "CustomerMinMarginPercent": { "type": "integer", "nullable": true } } } } }, "source": { "type": "object", "properties": { "Source": { "type": "object", "properties": { "SegmentationModel": { "type": "string" } } } } } } }, "configuration": { "type": "object", "properties": { "advanced": { "type": "object", "properties": { "Advanced": { "type": "object", "properties": { "AutoStop": { "type": "boolean" }, "MaxSteps": { "type": "integer" }, "Profiling": { "type": "boolean" }, "MaxDurationMinutes": { "type": "integer" } } } } }, "boundaries": { "type": "object", "properties": { "Boundaries": { "type": "object", "properties": { "OnInvoiceDiscountMaxPercent": { "type": "integer" }, "OnInvoiceDiscountMinPercent": { "type": "integer" }, "OffInvoiceDiscountMaxPercent": { "type": "integer" }, "OffInvoiceDiscountMinPercent": { "type": "integer" }, "SpecificAdjustmentMaxPercent": { "type": "integer" }, "SpecificAdjustmentMinPercent": { "type": "integer" }, "InvoicePriceMaxDecreasePercent": { "type": "integer" }, "InvoicePriceMaxIncreasePercent": { "type": "integer" } } } } }, "objectives": { "type": "object", "properties": { "Objectives": { "type": "object", "properties": { "RevenueMarginMixCoeff": { "type": "integer" }, "ProductGroupVolumeTarget": { "type": "array", "items": { "type": "object" } }, "CustomerGroupRevenueTarget": { "type": "array", "items": { "type": "object" } } } } } } } } } }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "submittedBy": { "type": "integer", "nullable": true }, "submittedByName": { "type": "string", "nullable": true }, "approvedBy": { "type": "integer", "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "deniedBy": { "type": "integer", "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "submitDate": { "type": "string", "format": "date-time", "nullable": true }, "workflowStatus": { "type": "string" }, "status": { "type": "string" }, "shotgunEnabled": { "type": "boolean" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "calculateModelObjectStepResponseExample": { "value": { "response": { "node": "node", "data": [ { "step": "results", "totalJobsCount": 2, "jobs": [ { "version": 1, "typedId": "2148031506.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "MODEL_CALCULATION", "targetObject": "2.MO", "jobName": "MC feature test", "concurrencyKey": "2148031505.JST", "calculationContext": "results / run_optimization", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "3oG8j", "calculableObjectTypedId": "2.MO", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3734326638", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 8, "distributed": false }, "createDate": "2022-09-14T10:13:37", "createdBy": 2147490187, "lastUpdateDate": "2022-09-14T10:13:37", "lastUpdateBy": 2147490187, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148031506 } ] }, { "version": 13, "typedId": "2.MO", "uniqueName": "MC feature test", "label": "To test MC feature, not optimization", "modelClassUN": "POAI_MC", "currentStep": "results", "state": { "definition": { "scope": { "Scope": { "ProductGroups": [], "CustomerGroups": [], "ProductMinRevenue": null, "CustomerMinRevenue": null, "ProductMinMarginPercent": null, "CustomerMinMarginPercent": null } }, "source": { "Source": { "SegmentationModel": "Seg_Godfather" } } }, "configuration": { "advanced": { "Advanced": { "AutoStop": true, "MaxSteps": 500, "Profiling": false, "MaxDurationMinutes": 0 } }, "boundaries": { "Boundaries": { "OnInvoiceDiscountMaxPercent": 30, "OnInvoiceDiscountMinPercent": 0, "OffInvoiceDiscountMaxPercent": 30, "OffInvoiceDiscountMinPercent": 0, "SpecificAdjustmentMaxPercent": 10, "SpecificAdjustmentMinPercent": -10, "InvoicePriceMaxDecreasePercent": 16, "InvoicePriceMaxIncreasePercent": 15 } }, "objectives": { "Objectives": { "RevenueMarginMixCoeff": 1, "ProductGroupVolumeTarget": [], "CustomerGroupRevenueTarget": [] } } } }, "createdByName": "thomas.sontheimer", "lastUpdateByName": "ondrej.tesar", "submittedBy": null, "submittedByName": null, "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": null, "workflowStatus": "DRAFT", "status": "CALCULATING", "shotgunEnabled": true, "createDate": "2021-12-02T08:46:36", "createdBy": 2147484799, "lastUpdateDate": "2022-09-14T10:13:37", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "toStep", "description": "Specify the step name to set the last step of the calculation (all steps before are executed, until `toStep` is reached)." } ] } }, "/optimization.modelcalcexec/{typedId}/{stepName}/{calcName}": { "parameters": [ { "schema": { "type": "string", "example": "123.MO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to recalculate the step for." }, { "schema": { "type": "string", "example": "definition", "enum": [ "definition", "configuration", "results", "projections", "parallel" ] }, "name": "stepName", "in": "path", "required": true, "description": "Enter the name of the step you want to calculate." }, { "schema": { "type": "string" }, "name": "calcName", "in": "path", "required": true, "description": "The name of the calculation you want to recalculate." } ], "post": { "summary": "Recalculate a Calculation of a Step", "operationId": "post-optimization.modelcalcexec-typedId-stepName-calcName", "tags": [ "Optimization" ], "description": "Executes a recalculation the calculation of the step as a background task (JST) in the context of the Model Object. Returns two elements within the `data` array – the JST (Job Status Tracker) object (the calculation status of the newly created calculation) and the updated ModelObject object.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "recalculateCalculationOfStepResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string" }, "totalJobsCount": { "type": "integer" }, "jobs": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "processingNode": { "type": "string", "nullable": true }, "threadId": { "type": "string", "nullable": true }, "threadUUID": { "type": "string", "nullable": true }, "status": { "type": "string" }, "trackerType": { "type": "string" }, "targetObject": { "type": "string" }, "jobName": { "type": "string" }, "concurrencyKey": { "type": "string" }, "calculationContext": { "type": "string" }, "progress": { "type": "string", "nullable": true }, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "integer" }, "priority": { "type": "integer" }, "messages": { "type": "object", "nullable": true }, "jobSettings": { "type": "object", "properties": { "distributedAction": { "type": "string", "nullable": true }, "jobType": { "type": "string" }, "uuid": { "type": "string" }, "calculableObjectTypedId": { "type": "string" }, "queueName": { "type": "string" }, "runNumber": { "type": "integer" }, "partitionName": { "type": "string" }, "partitionUUID": { "type": "string" }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "integer" }, "distributed": { "type": "boolean" } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "parameters": { "type": "string", "nullable": true }, "calculationResults": { "type": "string", "nullable": true }, "processingStart": { "type": "string", "nullable": true }, "processingEnd": { "type": "string", "nullable": true }, "id": { "type": "integer" } } } }, "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string", "nullable": true }, "modelClassUN": { "type": "string" }, "currentStep": { "type": "string" }, "state": { "type": "object", "properties": { "two_tabs": { "type": "object", "properties": { "tab1": { "type": "object", "properties": { "Data": { "type": "string" }, "QueryFail": { "type": "boolean" }, "OptionEntry": { "type": "string" }, "StringEntry": { "type": "string" }, "FailItemInParallel": { "type": "string" } } }, "tab2": { "type": "object", "properties": { "MatrixEntry": { "type": "array", "items": { "type": "object", "properties": { "col1": { "type": "string" }, "col2": { "type": "string" } } } }, "OptionEntry": { "type": "string" }, "StringEntry": { "type": "string", "nullable": true } } } } } } }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "submittedBy": { "type": "string", "nullable": true }, "submittedByName": { "type": "string", "nullable": true }, "approvedBy": { "type": "string", "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "deniedBy": { "type": "string", "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "submitDate": { "type": "string", "nullable": true }, "workflowStatus": { "type": "string" }, "status": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7489959459-smsvs", "data": [ { "step": "two_tabs", "totalJobsCount": 1, "jobs": [ { "version": 1, "typedId": "2153727837.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "MODEL_CALCULATION", "targetObject": "397.MO", "jobName": "TEST1", "concurrencyKey": "397.MO", "calculationContext": "two_tabs / simple_calc", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "SKLyn", "calculableObjectTypedId": "397.MO", "queueName": "SKLyn", "runNumber": 0, "partitionName": "mustard", "partitionUUID": "rGq9ZyL2vx", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 256, "distributed": false }, "createDate": "2023-03-15T14:58:48", "createdBy": 2147485367, "lastUpdateDate": "2023-03-15T14:58:48", "lastUpdateBy": 2147485367, "parameters": null, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2153727837 } ] }, { "version": 9, "typedId": "397.MO", "uniqueName": "TEST1", "label": null, "modelClassUN": "POAI_Test_Calc", "currentStep": "two_tabs", "state": { "two_tabs": { "tab1": { "Data": "DM.test", "QueryFail": false, "OptionEntry": "blue_pill", "StringEntry": "test", "FailItemInParallel": "no" }, "tab2": { "MatrixEntry": [ { "col1": "a1", "col2": "b1" }, { "col1": "a2", "col2": "b2" } ], "OptionEntry": "blue_pill", "StringEntry": null } } }, "createdByName": "victor.noel", "lastUpdateByName": "ondrej.tesar", "submittedBy": null, "submittedByName": null, "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": null, "workflowStatus": "DRAFT", "status": "CALCULATING", "createDate": "2022-03-02T10:37:14", "createdBy": 2147484202, "lastUpdateDate": "2023-03-15T14:58:48", "lastUpdateBy": 2147485367 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/optimization.modelcalcexec/{typedId}/{stepName}/{calcName}/item": { "parameters": [ { "schema": { "type": "string", "example": "123.MO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to recalculate the step for." }, { "schema": { "type": "string", "example": "definition", "enum": [ "definition", "configuration", "results", "projections", "parallel" ] }, "name": "stepName", "in": "path", "description": "Enter the name of the step you want to calculate.", "required": true }, { "schema": { "type": "string" }, "name": "calcName", "in": "path", "required": true, "description": "The name of the calculation you want to recalculate." } ], "post": { "summary": "Recalculate Items of a Parallel Calculation", "operationId": "post-optimization.modelcalcexec-typedId-stepName-calcName/item", "tags": [ "Optimization" ], "description": "Executes a recalculation of the item as a background task (JST) with the `id` of the last calculation JST (copies calculation results from the previous JST).
\nUse a filter in your request to specify items with `CREATED` or `FAILED` status. Cannot be used on items with the `CALCULATED` status.
\nFails if called for anything else than a Parallel Calculation.
\nReturns two elements within the `data` array – the JST (Job Status Tracker) object (the calculation status of the newly created calculation) and the updated ModelObject object.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "step": { "type": "string" }, "totalJobsCount": { "type": "integer" }, "jobs": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "processingNode": {}, "threadId": {}, "threadUUID": {}, "status": { "type": "string" }, "trackerType": { "type": "string" }, "targetObject": { "type": "string" }, "jobName": { "type": "string" }, "concurrencyKey": { "type": "string" }, "calculationContext": { "type": "string" }, "progress": {}, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "integer" }, "priority": { "type": "integer" }, "messages": {}, "jobSettings": { "type": "object", "properties": { "distributedAction": {}, "jobType": { "type": "string" }, "uuid": { "type": "string" }, "calculableObjectTypedId": { "type": "string" }, "queueName": { "type": "string" }, "runNumber": { "type": "integer" }, "partitionName": { "type": "string" }, "partitionUUID": { "type": "string" }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "integer" }, "distributed": { "type": "boolean" } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "parameters": {}, "calculationResults": {}, "processingStart": {}, "processingEnd": {}, "id": { "type": "integer" } } } }, "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "modelClassUN": { "type": "string" }, "currentStep": { "type": "string" }, "state": { "type": "object", "properties": { "two_tabs": { "type": "object", "properties": { "tab1": { "type": "object", "properties": { "Data": { "type": "string" }, "QueryFail": { "type": "boolean" }, "OptionEntry": { "type": "string" }, "StringEntry": { "type": "string" }, "FailItemInParallel": { "type": "string" } } }, "tab2": { "type": "object", "properties": { "MatrixEntry": { "type": "array", "items": { "type": "object", "properties": { "col1": { "type": "string" }, "col2": { "type": "string" }, "selected": { "type": "boolean" } } } }, "OptionEntry": { "type": "string" }, "StringEntry": {} } } } } } }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "submittedBy": {}, "submittedByName": {}, "approvedBy": {}, "approvedByName": {}, "deniedBy": {}, "deniedByName": {}, "submitDate": {}, "workflowStatus": { "type": "string" }, "status": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6689766d7c-6bzmz", "data": [ { "step": "parallel", "totalJobsCount": 1, "jobs": [ { "version": 1, "typedId": "2153728296.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "MODEL_PARALLEL_CALCULATION", "targetObject": "5436.MO", "jobName": "test_OnTe2", "concurrencyKey": "5436.MO", "calculationContext": "parallel / parallel_calc", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "zOfKx", "calculableObjectTypedId": "5436.MO", "queueName": "zOfKx", "runNumber": 0, "partitionName": "mustard", "partitionUUID": "rGq9ZyL2vx", "enableDirtyTracking": false, "agentOption1": false, "jobSize": 256, "distributed": true }, "createDate": "2023-03-17T11:56:16", "createdBy": 2147485367, "lastUpdateDate": "2023-03-17T11:56:16", "lastUpdateBy": 2147485367, "parameters": null, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2153728296 } ] }, { "version": 8, "typedId": "5436.MO", "uniqueName": "test_OnTe2", "label": "test_OnTe2", "modelClassUN": "POAI_Test_Calc", "currentStep": "parallel", "state": { "two_tabs": { "tab1": { "Data": "DM.products", "QueryFail": false, "OptionEntry": "blue_pill", "StringEntry": "test", "FailItemInParallel": "yes" }, "tab2": { "MatrixEntry": [ { "col1": "a1", "col2": "b1", "selected": true }, { "col1": "a2", "col2": "b2", "selected": true } ], "OptionEntry": "blue_pill", "StringEntry": null } } }, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "submittedBy": null, "submittedByName": null, "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": null, "workflowStatus": "DRAFT", "status": "CALCULATING", "createDate": "2023-03-17T11:42:53", "createdBy": 2147485367, "lastUpdateDate": "2023-03-17T11:56:16", "lastUpdateBy": 2147485367 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "criteria" ], "properties": { "criteria": { "type": "array", "items": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "string", "example": "FAILED", "enum": [ "FAILED", "CREATED" ] } } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "operator", "criteria" ] } } } } }, "required": [ "data" ] }, "examples": { "recalculatePCItemsRequestExample": { "value": { "data": { "criteria": [ { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "iEquals", "value": [ "FAILED" ] } ] } ] } } } } } } } } }, "/optimization.modelsave/{typedId}/{stepName}": { "parameters": [ { "schema": { "type": "string", "example": "123.MO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to save." }, { "schema": { "type": "string", "example": "definition", "enum": [ "definition", "configuration", "results", "projections" ] }, "name": "stepName", "in": "path", "required": true, "description": "Enter the name of the step you want to save. Steps are defined in the Model Class that is associated to the Model Object." } ], "post": { "summary": "Save a Model", "operationId": "post-optimization.modelsave-typedId-stepName", "tags": [ "Optimization" ], "description": "Saves a Model Object of the step. Returns the updated ModelObject object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "saveModelRequest", "properties": { "oldValues": { "type": "object", "required": [ "version" ], "properties": { "version": { "type": "integer" } } }, "data": { "$ref": "#/components/schemas/ModelObject" } }, "required": [ "oldValues" ] }, "examples": { "saveModelRequestExample": { "value": { "oldValues": { "version": 11 }, "data": { "state": { "configuration": { "advanced": { "Advanced": { "MaxSteps": 500, "MaxDurationMinutes": 0, "AutoStop": true, "Profiling": false } }, "boundaries": { "Boundaries": { "SpecificAdjustmentMinPercent": -10, "SpecificAdjustmentMaxPercent": 10, "OnInvoiceDiscountMinPercent": 0, "OnInvoiceDiscountMaxPercent": 30, "OffInvoiceDiscountMinPercent": 0, "OffInvoiceDiscountMaxPercent": 30, "InvoicePriceMaxDecreasePercent": 16, "InvoicePriceMaxIncreasePercent": 15 } }, "objectives": { "Objectives": { "RevenueMarginMixCoeff": 1, "CustomerGroupRevenueTarget": [], "ProductGroupVolumeTarget": [] } } } } } } } } } }, "description": "The `data` property can only contain the `state` field, all the rest fields will be ignored (and cannot be updated even with update/MO endpoint)." }, "responses": { "200": { "description": "OK. Returns the updated Model Object.", "content": { "application/json": { "schema": { "type": "object", "title": "saveModelResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelObject" } }, "status": { "type": "integer" } } } } }, "examples": { "saveModelResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 12, "typedId": "2.MO", "uniqueName": "MC feature test", "label": "To test MC feature, not optimization", "modelClassUN": "POAI_MC", "currentStep": "configuration", "state": { "definition": { "scope": { "Scope": { "ProductGroups": [], "CustomerGroups": [], "ProductMinRevenue": null, "CustomerMinRevenue": null, "ProductMinMarginPercent": null, "CustomerMinMarginPercent": null } }, "source": { "Source": { "SegmentationModel": "Seg_Godfather" } } }, "configuration": { "advanced": { "Advanced": { "AutoStop": true, "MaxSteps": 500, "Profiling": false, "MaxDurationMinutes": 0 } }, "boundaries": { "Boundaries": { "OnInvoiceDiscountMaxPercent": 30, "OnInvoiceDiscountMinPercent": 0, "OffInvoiceDiscountMaxPercent": 30, "OffInvoiceDiscountMinPercent": 0, "SpecificAdjustmentMaxPercent": 10, "SpecificAdjustmentMinPercent": -10, "InvoicePriceMaxDecreasePercent": 16, "InvoicePriceMaxIncreasePercent": 15 } }, "objectives": { "Objectives": { "RevenueMarginMixCoeff": 1, "ProductGroupVolumeTarget": [], "CustomerGroupRevenueTarget": [] } } } }, "createdByName": "thomas.sontheimer", "lastUpdateByName": "ondrej.tesar", "submittedBy": null, "submittedByName": null, "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": null, "workflowStatus": "DRAFT", "status": "DRAFT", "shotgunEnabled": true, "createDate": "2021-12-02T08:46:36", "createdBy": 2147484799, "lastUpdateDate": "2022-09-14T10:13:37", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } } } }, "/optimization.modelsubmit/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.MO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to submit." } ], "post": { "summary": "Submit a Model", "operationId": "post-optimization.modelsubmit-typedId", "tags": [ "Optimization" ], "description": "Submits a Model for approval. Returns the submited ModelObject object.\n>Note: A scheduled Model cannot be submitted.\nRequired permission: `MODELOBJECT_UPDATE`", "responses": { "200": { "description": "OK. Returns the Model Object.", "content": { "application/json": { "schema": { "type": "object", "title": "saveModelResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelObject" } }, "status": { "type": "integer" } } } } }, "examples": { "submitModelResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7d7d8875d-7jn6c", "data": [ { "version": 4, "typedId": "3.MO", "uniqueName": "SLIDER_test", "label": "SLIDER_test", "modelClassUN": "POAI_SLIDER_Test_Eval", "moduleCategoryUN": null, "userGroupEdit": null, "userGroupViewDetails": null, "currentStep": "onetab", "state": { "onetab": { "tab2": { "InlineConfigurator": { "SliderEntry": 30 } } } }, "createdByName": "sylvain.lemouzy", "lastUpdateByName": "ondrej.tesar", "submittedBy": 2147490187, "submittedByName": "ondrej.tesar", "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": "2023-07-10T11:36:08.223151", "workflowStatus": "SUBMITTED", "status": "READY", "createDate": "2022-12-20T07:52:05", "createdBy": 2147492194, "lastUpdateDate": "2023-07-10T11:36:08", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/optimization.modelcalcstatus/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.M" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to retrieve the calculation status for." } ], "post": { "summary": "Get a Calculation Status", "operationId": "post-optimization.modelcalcstatus-typedId", "responses": { "200": { "$ref": "#/components/responses/JobStatusTrackerResponse" } }, "tags": [ "Optimization" ], "description": "Retrieves the status of all calculations for the given Model." } }, "/optimization.modelcalcstatus/{typedId}/{stepName}": { "parameters": [ { "schema": { "type": "string", "example": "123.M" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to retrieve the calculation status for." }, { "schema": { "type": "string" }, "name": "stepName", "in": "path", "required": true, "description": "The name of the step you want to calculate." } ], "post": { "summary": "Get a Step Calculation Status", "operationId": "post-optimization.modelcalcstatus-typedId-stepName", "responses": { "200": { "$ref": "#/components/responses/JobStatusTrackerResponse" } }, "tags": [ "Optimization" ], "description": "Retrieves the status of the specified step calculation for the given Model." } }, "/optimization.modelcalccancel/{typedId}/{stepName}": { "parameters": [ { "schema": { "type": "string", "example": "123.M" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to cancel the calculation step for." }, { "schema": { "type": "string" }, "name": "stepName", "in": "path", "required": true, "description": "The name of the step you want to cancel." } ], "post": { "summary": "Cancel a Calculation Step", "operationId": "post-optimization.modelcalccancel-typedId-stepName", "responses": { "200": { "$ref": "#/components/responses/JobStatusTrackerResponse" } }, "tags": [ "Optimization" ], "description": "Cancels the calculation of the specified step for the given Model." } }, "/optimization.modelformulaparams/{typedId}/{stepName}/{formulaName}": { "parameters": [ { "schema": { "type": "string", "example": "123.M" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to retrieve logic parameters for." }, { "schema": { "type": "string" }, "name": "stepName", "in": "path", "required": true, "description": "The name of the step you want to list logic parameters for." }, { "schema": { "type": "string" }, "name": "formulaName", "in": "path", "required": true, "description": "The name of the logic you want to get parameters for." } ], "post": { "summary": "List Model Logic Parameters", "operationId": "post-optimization.modelformulaparams-typedId-stepName-formulaName", "tags": [ "Optimization" ], "description": "Retrieves parameters of the specified logic.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listModelLogicParametersResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "contextParameters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} }, "formulaParameterReference": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} } } } }, "status": { "type": "number" } } } } }, "examples": { "listModelLogicParamsResponseExample": { "value": { "response": { "node": "node", "data": [ { "contextParameters": [ { "name": "Scope", "label": "Scope", "lookupTableId": null, "url": "POAI_MC_Def_Eval_Scope_Configurator", "type": "INLINECONFIGURATOR", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "formulaParameterReference": [ { "elementName": "RevenueByCustomerGroup", "elementLabel": " ", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true }, { "elementName": "ProductsList", "elementLabel": "Products List", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true }, { "elementName": "CustomersByGroup", "elementLabel": " ", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true }, { "elementName": "RevenueByProductGroup", "elementLabel": " ", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true }, { "elementName": "Overview", "elementLabel": "Overview", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [], "formatType": null, "displayedInPriceShop": true }, { "elementName": "CustomersList", "elementLabel": "Customers List", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true }, { "elementName": "ProductsByGroup", "elementLabel": " ", "formulaName": "POAI_MC_Def_Eval_Scope", "formulaDate": "2020-01-01", "elementGroups": [ "calculation" ], "formatType": null, "displayedInPriceShop": true } ] } ], "status": 0 } } } } } } } } } }, "/optimization.modelformulaexec/{typedId}/{stepName}/{formulaName}": { "parameters": [ { "schema": { "type": "string", "example": "123.M" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Model Object you want to execute the logic for." }, { "schema": { "type": "string" }, "name": "stepName", "in": "path", "required": true, "description": "The name of the step you want to execute the logic for." }, { "schema": { "type": "string" }, "name": "formulaName", "in": "path", "required": true, "description": "The name of the logic you want to execute." } ], "post": { "summary": "Execute a Model Logic", "operationId": "post-optimization.modelformulaexec-typedId-stepName-formulaName", "tags": [ "Optimization" ], "description": "Executes the logic in the context of the model and the step. Returns logic results.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "executeModelLogicRequest", "type": "object", "properties": { "data": { "type": "object" } } }, "examples": { "executeModelLogicRequestExample": { "value": { "data": { "SegmentationModel": "Seg_Godfather", "targetDate": "2022-02-08T11:38:51.972Z" } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "executeModelLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "number" } } } } } } } } } } }, "/metadata.describe/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "example": "P", "enum": [ "ACTT", "AI", "AP", "APIK", "BD", "BPT", "BR", "C", "CA", "CAM", "CDESC", "CF", "CFS", "CFT", "CH", "CL", "CLLI", "CLLIAM", "CLR", "CLT", "CN", "CO", "COAM", "COCT", "COCTAM", "COHT", "COHTAM", "COLI", "COR", "CORAM", "COROLI", "CORS", "CORSC", "COT", "CS", "CT", "CTAM", "CTLI", "CTMU", "CTMUI", "CTT", "CTTAM", "CTTREE", "CW", "CX10", "CX20", "CX3", "CX30", "CX50", "CX6", "CX8", "CXAM", "DA", "DB", "DCR", "DCRAM", "DCRI", "DCRL", "DCRMC", "DCRT", "DE", "DI", "DM", "DMDC", "DMDL", "DMDS", "DMF", "DMM", "DMR", "DMT", "DP", "DPR", "DPT", "DREF", "DREG", "EDL", "ET", "EVT", "F", "FE", "FN", "HEVT", "HRT", "HRTAM", "IDC", "IE", "ISH", "JLTV", "JLTV2", "JLTVM", "JST", "LAT", "LT", "LTT", "LTV", "M", "MC", "MLTV", "MLTV2", "MLTV3", "MLTV4", "MLTV5", "MLTV6", "MLTVM", "MN", "MO", "MPL", "MPLAM", "MPLI", "MPLIT", "MPLT", "MR", "MRAM", "MT", "NT", "P", "PAM", "PBOME", "PCOMP", "PCOMPCO", "PCW", "PDESC", "PG", "PGI", "PGIM", "PGT", "PH", "PL", "PLI", "PLIM", "PLPGTT", "PLT", "PR", "PRAM", "PREF", "PT", "PWH", "PX10", "PX20", "PX3", "PX30", "PX50", "PX6", "PX8", "PXAM", "PXREF", "PYR", "PYRAM", "Q", "QAM", "QLI", "QMU", "QMUI", "QT", "QTT", "QTTAM", "R", "RAT", "RATM", "RBA", "RBAAM", "RBALI", "RBAROLI", "RBAT", "RBT", "RBTAM", "RR", "RRAM", "RRS", "RRSC", "RT", "SAT", "SC", "SCN", "SCNAM", "SCT", "SIAM", "SIM", "SIMI", "SL", "SLAM", "SX10", "SX20", "SX3", "SX30", "SX50", "SX6", "SX8", "SXAM", "TFA", "TODO", "U", "UG", "US", "W", "WD", "WF", "WFE", "XPGI", "XPLI", "XSIMI" ] }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to retrieve information for. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article." } ], "post": { "summary": "List Entity Fields", "operationId": "post-metadata.describe-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listEntityFieldsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "description": "The name of the entity." }, "typeCode": { "type": "string", "minLength": 1, "description": "The type code of the entity." }, "massEditable": { "type": "boolean", "description": "When set to **true**, the multiple records at once can be edited in this entity." }, "bulkLoadable": { "type": "boolean", "description": "When set to **true**, a bulk data can be loaded to the entity using, for example, a **/loaddata/{TypeCode}** endpoint." }, "businessKey": { "type": "array", "description": "Fields that make up a business key.", "items": { "type": "object" } }, "fields": { "type": "object", "description": "Entity fields and corresponding properties." } } } }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Metadata" ], "description": "Retrieves information (data type, maximum length, possible values, whether the field is required, etc.) about fields of the specified entity.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "name", "description": "The name of the PX or CX category." }, { "schema": { "type": "string" }, "in": "query", "name": "lookupTableId", "description": "The ID of the Company Parameters table when retrieving MLTV (`MatrixLookupTableValue`)." } ] } }, "/metadata.fetch/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "example": "P", "enum": [ "ACTT", "AI", "AP", "APIK", "BD", "BPT", "BR", "C", "CA", "CAM", "CDESC", "CF", "CFS", "CFT", "CH", "CL", "CLLI", "CLLIAM", "CLR", "CLT", "CN", "CO", "COAM", "COCT", "COCTAM", "COHT", "COHTAM", "COLI", "COR", "CORAM", "COROLI", "CORS", "CORSC", "COT", "CS", "CT", "CTAM", "CTLI", "CTMU", "CTMUI", "CTT", "CTTAM", "CTTREE", "CW", "CX10", "CX20", "CX3", "CX30", "CX50", "CX6", "CX8", "CXAM", "DA", "DB", "DCR", "DCRAM", "DCRI", "DCRL", "DCRMC", "DCRT", "DE", "DI", "DM", "DMDC", "DMDL", "DMDS", "DMF", "DMM", "DMR", "DMT", "DP", "DPR", "DPT", "DREF", "DREG", "EDL", "ET", "EVT", "F", "FE", "FN", "HEVT", "HRT", "HRTAM", "IDC", "IE", "ISH", "JLTV", "JLTV2", "JLTVM", "JST", "LAT", "LT", "LTT", "LTV", "M", "MC", "MLTV", "MLTV2", "MLTV3", "MLTV4", "MLTV5", "MLTV6", "MLTVM", "MN", "MO", "MPL", "MPLAM", "MPLI", "MPLIT", "MPLT", "MR", "MRAM", "MT", "NT", "P", "PAM", "PBOME", "PCOMP", "PCOMPCO", "PCW", "PDESC", "PG", "PGI", "PGIM", "PGT", "PH", "PL", "PLI", "PLIM", "PLPGTT", "PLT", "PR", "PRAM", "PREF", "PT", "PWH", "PX10", "PX20", "PX3", "PX30", "PX50", "PX6", "PX8", "PXAM", "PXREF", "PYR", "PYRAM", "Q", "QAM", "QLI", "QMU", "QMUI", "QT", "QTT", "QTTAM", "R", "RAT", "RATM", "RBA", "RBAAM", "RBALI", "RBAROLI", "RBAT", "RBT", "RBTAM", "RR", "RRAM", "RRS", "RRSC", "RT", "SAT", "SC", "SCN", "SCNAM", "SCT", "SIAM", "SIM", "SIMI", "SL", "SLAM", "SX10", "SX20", "SX3", "SX30", "SX50", "SX6", "SX8", "SXAM", "TFA", "TODO", "U", "UG", "US", "W", "WD", "WF", "WFE", "XPGI", "XPLI", "XSIMI" ] }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to retrieve information for. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article." } ], "post": { "summary": "List Attribute Fields' Metadata", "operationId": "post-metadata.fetch-TypeCode", "tags": [ "Metadata" ], "description": "Retrieves metadata of *attribute* fields.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "name", "description": "The name of the PX or CX category." }, { "schema": { "type": "string" }, "in": "query", "name": "lookupTableId", "description": "The ID of the Company Parameters table when retrieving MLTV (`MatrixLookupTableValue`)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listAttributeFieldsMetadata", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "attributeMetas": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "fieldName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "fieldType": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "fieldValueOptions": {}, "cssProperties": {}, "description": { "type": "string" }, "requiredField": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "entityRefTypeCode": { "type": "string" }, "labelTranslations": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } }, "required": [ "version", "typedId", "fieldName", "label", "fieldType", "formatType", "description", "requiredField", "readOnly", "entityRefTypeCode", "labelTranslations", "name", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ] } }, "jsonSchema": { "type": "object", "properties": { "properties": { "type": "object", "required": [ "version", "typedId", "name", "sku", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy", "attribute1", "attribute2", "attribute3", "attribute4", "attribute5", "attribute6", "attribute7", "attribute8", "attribute9", "attribute10", "attribute11", "attribute12", "attribute13", "attribute14", "attribute15", "attribute16", "attribute17", "attribute18", "attribute19", "attribute20", "attribute21", "attribute22", "attribute23", "attribute24", "attribute25", "attribute26", "attribute27", "attribute28", "attribute29", "attribute30" ], "properties": { "version": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "typedId": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "name": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "sku": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "createDate": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "createdBy": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "lastUpdateDate": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "lastUpdateBy": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute1": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute2": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute3": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute4": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute5": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute6": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute7": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute8": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute9": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute10": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute11": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute12": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute13": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute14": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute15": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute16": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute17": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute18": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute19": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute20": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute21": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute22": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute23": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute24": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute25": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute26": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute27": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute28": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute29": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } }, "attribute30": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "minLength": 1 } } } } } } }, "attributeMetaSignificantFields": { "type": "array", "items": { "type": "object" } }, "attributeMetaTypeCode": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "string", "csrfToken": "string", "data": [ { "attributeMetas": [ { "version": 0, "typedId": "string", "fieldName": "string", "label": "string", "fieldType": 0, "formatType": "string", "fieldValueOptions": null, "cssProperties": null, "description": "string", "requiredField": true, "readOnly": true, "entityRefTypeCode": "string", "labelTranslations": "string", "name": "string", "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "jsonSchema": { "properties": { "version": { "type": "string" }, "typedId": { "type": "string" }, "name": { "type": "string" }, "sku": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "string" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "string" }, "attribute1": { "type": "string" }, "attribute2": { "type": "string" }, "attribute3": { "type": "string" }, "attribute4": { "type": "string" }, "attribute5": { "type": "string" }, "attribute6": { "type": "string" }, "attribute7": { "type": "string" }, "attribute8": { "type": "string" }, "attribute9": { "type": "string" }, "attribute10": { "type": "string" }, "attribute11": { "type": "string" }, "attribute12": { "type": "string" }, "attribute13": { "type": "string" }, "attribute14": { "type": "string" }, "attribute15": { "type": "string" }, "attribute16": { "type": "string" }, "attribute17": { "type": "string" }, "attribute18": { "type": "string" }, "attribute19": { "type": "string" }, "attribute20": { "type": "string" }, "attribute21": { "type": "string" }, "attribute22": { "type": "string" }, "attribute23": { "type": "string" }, "attribute24": { "type": "string" }, "attribute25": { "type": "string" }, "attribute26": { "type": "string" }, "attribute27": { "type": "string" }, "attribute28": { "type": "string" }, "attribute29": { "type": "string" }, "attribute30": { "type": "string" } } }, "attributeMetaSignificantFields": [ {} ], "attributeMetaTypeCode": "string" } ], "status": 0 } } } } } } } } } }, "/cfsmanager.calculate/{id}": { "parameters": [ { "$ref": "#/components/parameters/id" } ], "post": { "summary": "Calculate a CFS", "operationId": "post-cfsmanager.calculate-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "calculateCFSResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "processingNode": {}, "threadId": {}, "threadUUID": {}, "status": { "type": "string", "minLength": 1 }, "trackerType": { "type": "string", "minLength": 1 }, "targetObject": { "type": "string", "minLength": 1 }, "jobName": { "type": "string", "minLength": 1 }, "concurrencyKey": { "type": "string", "minLength": 1 }, "calculationContext": {}, "progress": {}, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "number" }, "priority": { "type": "number" }, "messages": {}, "jobSettings": { "type": "object", "properties": { "distributedAction": {}, "jobType": { "type": "string", "minLength": 1 }, "uuid": { "type": "string", "minLength": 1 }, "calculableObjectTypedId": { "type": "string", "minLength": 1 }, "queueName": {}, "runNumber": { "type": "number" }, "partitionName": { "type": "string", "minLength": 1 }, "partitionUUID": { "type": "string", "minLength": 1 }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "number" }, "distributed": { "type": "boolean" } } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "calculationResults": {}, "processingStart": {}, "processingEnd": {}, "id": { "type": "number" } } } }, "status": { "type": "number" } } } } }, "examples": { "calculateCFSResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "2147859822.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "CFS", "targetObject": "14.CFS", "jobName": "CFS", "concurrencyKey": "P", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "CFS", "uuid": "C2kQE", "calculableObjectTypedId": "14.CFS", "queueName": null, "runNumber": 0, "partitionName": "companypartition", "partitionUUID": "KzFdIp56g1", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 8, "distributed": false }, "createDate": "2022-01-25T16:53:19", "createdBy": 2147490696, "lastUpdateDate": "2022-01-25T16:53:19", "lastUpdateBy": 2147490696, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2147859822 } ], "status": 0 } } } } } } } }, "tags": [ "Calculated Field Sets" ], "description": "Executes a calculation of the Calculated Fields Set (specified by `id` as a path parameter)." } }, "/cfsmanager.cancel/{id}": { "parameters": [ { "$ref": "#/components/parameters/id" } ], "post": { "summary": "Cancel a CFS Calculation", "operationId": "post-cfsmanager.cancel-id", "tags": [ "Calculated Field Sets" ], "description": "Cancels a calculation of the Calculated Fields Set (specified by `id` as a path parameter).", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } } } }, "/fetch/CFS": { "post": { "summary": "List Calculated Field Sets", "operationId": "post-fetch-CFS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "listCalculatedFieldSetsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "locale": {}, "calculationMessages": { "type": "string", "minLength": 1 }, "numberOfItems": { "type": "number" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "configuration": { "type": "string", "minLength": 1 }, "relativeTargetDateDays": {}, "numberOfFailedItems": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "status": { "type": "string", "minLength": 1 }, "calculationStartDate": { "type": "string", "minLength": 1 }, "calculationDate": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "listCFSResponseExample": { "value": { "response": { "node": "node", "startRow": 0, "data": [ { "version": 4, "typedId": "13.CFS", "targetDate": "2022-01-25", "label": "CFS", "locale": null, "calculationMessages": "[]", "numberOfItems": 8, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"sourceFilterCriteria\":{},\"sortKeys\":null,\"sourceTypeCode\":\"P\",\"lookupTableValueType\":null,\"lookupTableUniqueName\":null,\"MPLUniqueName\":null,\"inputs\":[],\"formulaName\":\"CFS_ProductCostCurrencyConversion\",\"sourceConcurrencySuffix\":null,\"clearOnError\":false,\"mappings\":[],\"shotgunModeEnabled\":false,\"preserveLastUpdate\":false}", "relativeTargetDateDays": null, "numberOfFailedItems": 0, "userGroupEdit": null, "userGroupViewDetails": null, "createDate": "2022-01-26T11:49:51", "createdBy": 2147490696, "lastUpdateDate": "2022-01-26T11:50:14", "lastUpdateBy": 2147490696, "status": "READY", "calculationStartDate": "2022-01-26T11:50:14", "calculationDate": "2022-01-26T11:50:14" } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Calculated Field Sets" ], "description": "Retrieves Calculated Fields Sets. A filter can be applied." } }, "/delete/CFS": { "post": { "summary": "Delete a Calculated Field Set", "operationId": "post-delete-CFS", "responses": { "200": { "description": "OK" } }, "tags": [ "Calculated Field Sets" ], "description": "Deletes a Calculated Fields Set (CFS).", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "deleteCalculatedFieldSetRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteCFSRequestExample": { "value": { "data": { "typedId": "14.CFS" } } } } } } } } }, "/heartbeat.fetchtasks": { "post": { "summary": "List Tasks", "operationId": "post-heartbeat.fetchtasks", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Heartbeat" ], "description": "Retrieves a list of tasks to be handled by the heartbeat service.\n\n\n>This endpoint is disabled via `backgroundWorkers.enableRemoteManagement` by default." } }, "/token": { "post": { "summary": "Get an Authentication Token (API V2 only)", "operationId": "post-token", "responses": { "200": { "$ref": "#/components/responses/tokenResponse" }, "400": { "description": "The request was malformed.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getAuthenticationTokenAPIv2400Response", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized - the login credentials were incorrect.\n", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "getAuthenticationTokenAPIv2401Response", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden - The request did not contain a valid Pricefx-Key, the provided credentials in `body` were incorrect, the user was banned or not found or device registration required." } }, "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "Pricefx-Key", "description": "The Pricefx API key. Contact Pricefx Support to get your Pricefx-Key.", "required": true } ], "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "getAuthenticationTokenAPIv2Request", "type": "object", "properties": { "username": { "type": "string", "minLength": 1 }, "partition": { "type": "string", "minLength": 1 }, "password": { "type": "string", "minLength": 1, "description": "A clear-text password." } }, "required": [ "username", "partition", "password" ] } } } }, "description": "Retrieves the access token, token type and the refresh token." }, "delete": { "summary": "Delete an Authentication Token (API V2 only)", "operationId": "delete-token", "responses": { "204": { "description": "Logout successful." }, "403": { "description": "Forbidden - The request did not contain a valid Pricefx-Key, the provided credentials in `body` were incorrect, the user was banned or not found or device registration required.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "deleteAuthenticationTokenAPIv2403Response", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ] } } } } }, "tags": [ "Authentication" ], "description": "Invalidates an access token.", "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "Pricefx-Key", "description": "The Pricefx API key. Contact Pricefx Support to get your Pricefx-Key." } ] } }, "/token/refresh": { "post": { "summary": "Refresh an Authentication Token (API V2 only)", "operationId": "post-token-refresh", "responses": { "200": { "$ref": "#/components/responses/tokenResponse" }, "400": { "description": "The request was malformed.", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "refreshAuthenticationTokenAPIv2400Response", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ] } } } }, "401": { "description": "Unauthorized - the login credentials were incorrect.\n", "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "refreshAuthenticationTokenAPIv2401Response", "properties": { "error": { "type": "string", "minLength": 1 } }, "required": [ "error" ] } } } }, "403": { "description": "Forbidden - The request did not contain a valid Pricefx-Key, the provided credentials in `body` were incorrect, the user was banned or not found or device registration required." } }, "parameters": [ { "schema": { "type": "string" }, "in": "header", "name": "Pricefx-Key", "description": "The Pricefx API key. Contact Pricefx Support to get your Pricefx-Key.", "required": true } ], "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "refresh-token": { "type": "string" } } } } }, "description": "Provide the referesh token." }, "description": "Retrieves a new access token, token type, the refresh token, and expiration time." }, "parameters": [] }, "/add/CFOT": { "post": { "summary": "Create a Custom Form Type", "operationId": "post-add-CFOT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "title": "createCustomFormTypeResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "$ref": "#/components/schemas/CustomFormType" }, "status": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "title": "createCustomFormTypeRequest", "properties": { "operation": { "type": "string", "minLength": 1 }, "data": { "type": "object", "required": [ "uniqueName", "headerFormulaName", "embedded" ], "properties": { "uniqueName": { "type": "string", "minLength": 1, "description": "A name of the Custom Form Type." }, "label": { "type": "string", "minLength": 1, "description": "A label of the Custom Form Type." }, "headerFormulaName": { "type": "string", "minLength": 1, "description": "A Custom Form header logic that defines the inputs, calculation results or a custom header. For embedded Custom Forms, it also defines communication with the parent object." }, "workflowFormulaName": { "type": "string" }, "embedded": { "type": "boolean", "description": "Sets whether the Custom Form will be standalone or embedded in a module." }, "supportedParentTypeCodes": { "type": "string", "description": "List of entities, which are allowed to embed this custom form type (Quote, standalone Custom Form). This is meaningful only when embedded is `true`." }, "module": { "type": "string", "minLength": 1, "description": "Applies to standalone Custom Forms. Select a module in whose main menu you want to have this Custom Form available." }, "configuration": { "type": "object", "description": "Applies only to standalone Custom Forms, add a JSON definition describing the content of the Custom Form – its steps and tabs.", "properties": { "default": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "translationKey": { "type": "string", "minLength": 1 }, "icon": { "type": "string", "minLength": 1 }, "tabs": { "type": "object", "properties": { "details": { "type": "object", "required": [ "name", "translationKey", "type", "icon" ], "properties": { "name": { "type": "string", "minLength": 1 }, "translationKey": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "icon": { "type": "string", "minLength": 1 } } } } } } } } } } } }, "required": [ "operation", "data" ] }, "examples": { "createCustomFormTypeRequestExample": { "value": { "operation": "add", "data": { "uniqueName": "CFOT01", "label": "CustomFormType01", "headerFormulaName": "cflogic", "embedded": false, "configuration": { "default": { "name": "default", "translationKey": "common_default", "icon": "compress-arrows", "tabs": { "details": { "name": "details", "translationKey": "dynamicTab_details", "type": "details", "icon": "file-info-alt" } } } }, "module": "PRICESETTING" } } } } } } }, "tags": [ "Custom Forms" ], "description": "Creates a new standalone or embedded Custom Form Type." } }, "/fetch/CFOT": { "post": { "summary": "List Custom Form Types", "operationId": "post-fetch-CFOT", "tags": [ "Custom Forms" ], "description": "Retrieves a list of Custom Form Types.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listCustomFormTypesRequest", "type": "object", "properties": { "endRow": { "type": "number" }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "textMatchStyle": { "type": "string", "minLength": 1 }, "data": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } } } } } }, "examples": { "listCustomFormTypesRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "module", "operator": "equals", "value": "QUOTING" } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "title": "listCustomFormTypesResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "headerFormulaName": { "type": "string", "minLength": 1 }, "embedded": { "type": "boolean" }, "supportedParentTypeCodes": { "type": "array", "items": {} }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "listCustomFormTypesResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7f5685597f-7p2tn", "startRow": 0, "data": [ { "version": 0, "typedId": "4.CFOT", "uniqueName": "CFOT", "label": "CustomFormType", "headerFormulaName": "CFOTlogic", "embedded": true, "supportedParentTypeCodes": [ "CUSTOM_FORM", "QUOTING" ], "createDate": "2022-05-19T11:47:28", "createdBy": 2147490696, "lastUpdateDate": "2022-05-19T11:47:28", "lastUpdateBy": 2147490696 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } } } }, "/update/CFOT": { "post": { "summary": "Update a Custom Form Type", "tags": [ "Custom Forms" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateCustomFormTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFormType" } }, "status": { "type": "integer" } } } } }, "examples": { "updateCustomFormTypeResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 4, "typedId": "7.CFOT", "uniqueName": "CFOT", "label": "MyCustomFormType", "headerFormulaName": "cflogic", "workflowFormulaName": null, "userGroupEdit": null, "userGroupViewDetails": null, "embedded": true, "supportedParentTypeCodes": null, "module": "QUOTING", "configuration": null, "createDate": "2022-05-20T15:02:00", "createdBy": 2147490696, "lastUpdateDate": "2022-06-24T08:16:17", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "operationId": "post-update-CFOT", "description": "Updates a Custom Form Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCustomFormTypeRequest", "properties": { "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "headerFormulaName": { "type": "string" }, "embedded": { "type": "boolean" }, "module": { "type": "string" }, "configuration": { "type": "object", "properties": { "default": { "type": "object", "properties": { "icon": { "type": "string" }, "name": { "type": "string" }, "tabs": { "type": "object", "properties": { "details": { "type": "object", "properties": { "icon": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "translationKey": { "type": "string" } } } } }, "translationKey": { "type": "string" } } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "embedded": { "type": "boolean" }, "configuration": { "anyOf": [ { "type": "object", "nullable": true }, { "type": "string", "nullable": true } ] }, "module": { "anyOf": [ { "type": "object", "nullable": true }, { "type": "string", "nullable": true } ] }, "supportedParentTypeCodes": { "anyOf": [ { "type": "array", "nullable": true }, { "type": "string", "nullable": true } ] }, "typedId": { "type": "string" }, "workflowFormulaName": { "anyOf": [ { "type": "string", "nullable": true } ] } } } } }, "examples": { "updateCustomFormTypeRequestExample": { "value": { "oldValues": { "version": 3, "typedId": "7.CFOT", "uniqueName": "CFOT", "label": "MyCustomFormType", "headerFormulaName": "cflogic", "embedded": false, "module": "QUOTING", "configuration": { "default": { "icon": "compress-arrows", "name": "default", "tabs": { "details": { "icon": "file-info-alt", "name": "details", "type": "details", "translationKey": "dynamicTab_details" } }, "translationKey": "common_default" } }, "createDate": "2022-05-20T15:02:00", "createdBy": 2147490696, "lastUpdateDate": "2022-05-23T10:18:46", "lastUpdateBy": 2147490696 }, "operationType": "update", "textMatchStyle": "exact", "data": { "embedded": true, "configuration": null, "module": null, "supportedParentTypeCodes": null, "typedId": "7.CFOT", "workflowFormulaName": null } } } } } } } } }, "/delete/CFOT": { "post": { "summary": "Delete a Custom Form Type", "operationId": "post-delete-CFOT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "$ref": "#/components/schemas/CustomFormType" }, "status": { "type": "number" } } } } } } } } }, "tags": [ "Custom Forms" ], "description": "Deletes a Custom Form Type by `typedId`.", "requestBody": { "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "minLength": 1 } }, "required": [ "typedId" ] } }, "required": [ "data" ] }, "examples": { "deleteCustomFormTypeRequestExample": { "value": { "data": { "typedId": "10.CFOT" } } } } } } } } }, "/customform.add": { "post": { "summary": "Create a Custom Form", "operationId": "post-customform.add", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "type": "object", "properties": { "response": { "type": "object", "title": "createCustomFormResponse", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "$ref": "#/components/schemas/CustomForm" }, "status": { "type": "number" } } } } }, "examples": { "createCustomFormResponseExample": { "value": { "response": { "node": "string", "data": { "outputs": [ { "resultName": "string", "resultLabel": "string", "result": 0, "excludeFromExport": true, "warnings": [ "string" ], "alertMessage": "string", "alertType": "RED", "displayOptions": 0, "formatType": "NUMERIC", "suffix": "string", "resultType": "string", "cssProperties": "string", "userGroup": "string", "resultGroup": "string", "overrideValueOptions": [ [ null ] ], "overrideAllowEmpty": true, "labelTranslations": "string", "overridable": true, "overridden": true, "resultDescription": "string" } ], "createdByName": "string", "typedId": "string", "inputs": [ { "name": "string", "label": "string", "lookupTableId": "string", "url": "string", "type": "string", "value": 0, "valueHint": "string", "readOnly": true, "filter": { "property1": {}, "property2": {} }, "parameterGroup": "string", "required": true, "labelTranslations": "string", "addUnknownValues": true, "typedId": "string", "alwaysEditable": true, "inputs": [ {} ], "parameterConfig": { "property1": {}, "property2": {} }, "formattingOptions": { "property1": {}, "property2": {} }, "valueOptions": [ "string" ] } ], "workflowStatus": "DRAFT", "lastUpdateDate": "string", "serverMessagesExtended": [ { "key": "string", "message": "string" } ], "customFormTypeObject": { "version": 0, "typedId": "string", "uniqueName": "string", "label": "string", "headerFormulaName": "string", "workflowFormulaName": "string", "userGroupEdit": "string", "userGroupViewDetails": "string", "embedded": true, "supportedParentTypeCodes": [ "string" ], "module": "QUOTING", "configuration": {}, "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 }, "deniedByName": "string", "userGroupViewDetails": "string", "approvedByName": "string", "results": {}, "module": "QUOTING", "version": 0, "attribute9": "string", "attribute8": "string", "uniqueName": "string", "attribute5": "string", "attribute4": "string", "attribute7": "string", "attribute6": "string", "attribute1": "string", "attribute14": "string", "formStatus": "DRAFT", "attribute13": "string", "typeId": 0, "userGroupEdit": "string", "attribute3": "string", "attribute12": "string", "attribute2": "string", "attribute11": "string", "attribute10": "string", "lastUpdateByName": "string", "attribute19": "string", "attribute18": "string", "attribute17": "string", "attribute16": "string", "attribute15": "string", "submitDate": "string", "parentTypedId": "string", "attribute25": "string", "submittedByName": "string", "attribute24": "string", "attribute23": "string", "attribute22": "string", "attribute21": "string", "attribute20": "string", "createDate": "string", "approvalRequiredEmailAttachments": [ {} ], "attribute29": "string", "attribute28": "string", "attribute27": "string", "attribute26": "string", "label": "string", "createdBy": 0, "calculationStatus": 0, "attribute30": "string", "lastUpdateBy": 0 }, "status": 0 } } } } } } } }, "tags": [ "Custom Forms" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "createCustomFormRequest", "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId", "label" ], "properties": { "typedId": { "type": "string", "minLength": 1, "description": "The `typedId` of the Custom Form Type." }, "label": { "type": "string", "minLength": 1 }, "userGroupEdit": { "type": "string", "minLength": 1, "nullable": true } } }, "operation": { "type": "string", "minLength": 1 } }, "required": [ "data" ] }, "examples": { "createCustomFormRequestExample": { "value": { "data": { "typedId": "7.CFOT", "label": "The Form", "userGroupEdit": "Administrators,PricingManagers" }, "operation": "add" } }, "createCustomFormRequestExample2": { "value": { "data": { "label": "Copy of inputs", "parentTypedId": null, "typeId": 7, "userGroupEdit": null, "userGroupViewDetails": null, "module": null, "results": null, "inputs": null, "outputs": null, "calculationStatus": 0, "submitDate": "2022-06-07", "workflowStatus": "NO_APPROVAL_REQUIRED", "formStatus": "APPROVED", "submittedByName": null, "approvedByName": "admin", "deniedByName": null, "createdByName": null, "lastUpdateByName": "admin", "serverMessagesExtended": null, "approvalRequiredEmailAttachments": [], "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "customFormTypeObject": null, "typedId": "7.CFOT" } } } } } }, "description": "" }, "description": "Creates a new Custom Form." } }, "/customform.fetch/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.CFO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Custom Form you want to retrieve details for." } ], "post": { "summary": "Get a Custom Form", "operationId": "post-customform.fetch-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "", "title": "getCustomFormResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "parentTypedId": {}, "typeId": { "type": "number" }, "userGroupEdit": {}, "userGroupViewDetails": {}, "module": {}, "results": {}, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": { "type": "number" }, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": { "type": "boolean" }, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "properties": { "formatType": { "type": "string", "minLength": 1 }, "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 } } }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": {}, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": {}, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": {}, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} } } }, "calculationStatus": { "type": "number" }, "submitDate": {}, "workflowStatus": { "type": "string", "minLength": 1 }, "formStatus": { "type": "string", "minLength": 1 }, "submittedByName": {}, "approvedByName": {}, "deniedByName": {}, "createdByName": {}, "lastUpdateByName": {}, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "serverMessagesExtended": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "customFormTypeObject": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "headerFormulaName": { "type": "string", "minLength": 1 }, "workflowFormulaName": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "embedded": { "type": "boolean" }, "supportedParentTypeCodes": { "type": "array", "items": { "type": "object" } }, "module": { "type": "string", "minLength": 1 }, "configuration": { "type": "object", "properties": { "default": { "type": "object", "required": [ "icon", "name", "tabs", "translationKey" ], "properties": { "icon": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "tabs": { "type": "object", "required": [ "details" ], "properties": { "details": { "type": "object", "required": [ "icon", "name", "type", "translationKey" ], "properties": { "icon": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "translationKey": { "type": "string", "minLength": 1 } } } } }, "translationKey": { "type": "string", "minLength": 1 } } } } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } } } }, "status": { "type": "number" } } } } } } } }, "400": { "description": "Invalid `typedId` specified in the path param." }, "404": { "description": "Custom Form with the specified `typedId` was not found." } }, "tags": [ "Custom Forms" ], "description": "Retrieves the Custom Form (specified by `typedId`), including all details." } }, "/customform.search": { "parameters": [], "post": { "summary": "List Custom Forms", "operationId": "post-customform.search", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "listCustomFormsResponse", "properties": { "node": { "type": "string" }, "status": { "type": "integer" }, "data": { "$ref": "#/components/schemas/CustomForm" } } } } }, "examples": {} } } } }, "tags": [ "Custom Forms" ], "description": "Retrieves a list of Custom Forms of the specified Custom Form Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCustomFormsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": {}, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "_constructor": { "type": "string" } } } } } } } }, "examples": { "listCustomFormsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "typeId", "operator": "equals", "value": "11.CFOT", "_constructor": "AdvancedCriteria" } ] } } } } } } } } }, "/customform.changestatus/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "235.CFO" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Custom Form whose status you want to change." } ], "post": { "summary": "Change a Custom Form Status", "operationId": "post-customform.changestatus-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "changeCustomFormStatusResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/CustomForm" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Custom Forms" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "changeCustomFormStatusRequest", "properties": { "data": { "type": "object", "properties": { "operation": { "type": "string", "description": "The status you want the Custom Form to be changed to.", "example": "SUBMIT, REVOKE, WITHDRAW" } } } } } } } }, "description": "Allows you to submit, revoke, or withrdraw the Custom Form." } }, "/customform.update": { "post": { "summary": "Update a Custom Form", "operationId": "post-customform.update", "responses": { "200": { "description": "The Custom Form was updated successfully. The response includes the updated data.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "updateCustomFormResponse", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/CustomForm" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Custom Forms" ], "description": "Allows you to update *Label*, *User Group (Edit)*, and *User Group (View Details)* fields of the specified Custom Form.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCustomFormRequest", "properties": { "data": { "type": "object", "properties": { "label": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "typedId": { "type": "string", "description": "The `typedId` of the Custom Form you want to update." } }, "required": [ "typedId" ] }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "operationType" ] }, "examples": { "updateCustomFormRequestExample": { "value": { "data": { "label": "Test Custom Form", "userGroupEdit": "Administrators", "userGroupViewDetails": "Administrators", "typedId": "238.CFO" }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/customform.delete": { "post": { "summary": "Delete a Custom Form", "operationId": "post-customform.delete", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Custom Forms" ], "description": "Deletes specified Custom Forms.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteCustomFormRequest", "properties": { "data": { "type": "object", "properties": { "typedIds": { "type": "array", "description": "One or more `typedId` of the Custom Form(s) you want to delete.", "items": { "type": "string", "example": "123.CFO" } } }, "required": [ "typedIds" ] } } }, "examples": { "deleteCustomFormRequestExample": { "value": { "data": { "typedIds": [ "332.CFO", "334.CFO" ] } } } } } } } } }, "/customform.duplicate/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.CFO" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Custom Form you want to duplicate." } ], "post": { "summary": "Duplicate a Custom Form", "operationId": "post-customform.duplicate-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomForm" } }, "status": { "type": "integer" } } } } }, "examples": { "duplicateCustomFormResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-8bdb777df-dn9xf", "data": [ { "version": 2, "typedId": "533.CFO", "uniqueName": "CFO-533", "label": "Copy of my custom form 1", "parentTypedId": null, "typeId": 7, "userGroupEdit": "groupEdit", "userGroupViewDetails": "viewGroup", "module": "QUOTING", "moduleCategoryUN": null, "results": null, "inputs": [ { "name": "input", "label": null, "lookupTableId": null, "url": null, "type": "USERENTRY", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": { "resultName": "input", "resultLabel": "input" }, "formattingOptions": {}, "valueOptions": null } ], "outputs": [], "calculationStatus": 0, "submitDate": null, "workflowStatus": "DRAFT", "formStatus": "DRAFT", "submittedByName": null, "approvedByName": null, "deniedByName": null, "createdByName": "admin", "lastUpdateByName": "admin", "originCustomFormId": 284, "originDeleted": false, "originLabel": "my custom form 1", "originUniqueName": "CFO-284", "renderInfo": null, "serverMessagesExtended": [], "approvalRequiredEmailAttachments": [], "createDate": "2023-10-12T10:40:23", "createdBy": 2147490696, "lastUpdateDate": "2023-10-12T10:40:23", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "customFormTypeObject": null, "supersededBy": null, "prevRev": null, "rootUniqueName": "CFO-533" } ], "status": 0 } } } } } } } }, "tags": [ "Custom Forms" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "description": "Creates a copy of the specified Custom Form. The copy includes inputs, outputs, and embedded objects. Returns the duplicated Custom Form.

\n\nDuplicated Custom Form fields:

\n\n**The Custom Form has an origin and it is not deleted**\n\n`originCustomFormId`, `originDeleted`, `originLabel`, `originUniqueName` fields in the duplicated CFO object contain a copy of corresponding fields from the original Custom Form.\n\n**The Custom Form origin has been deleted**\n\n`originCustomFormId` is the id of the original Custom Form, `originDeleted` set to `true`. `originLabel` and `originUniqueName` fields are null.\n\n**The Custom Form does not have an origin** (the CFO is not duplicated)\n\n`originCustomFormId`, `originDeleted`, `originLabel`, `originUniqueName` fields have a `null` value." } }, "/customform.createnewrevision/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Custom Form you want to create a revision from." } ], "post": { "summary": "Create a Custom Form Revision", "operationId": "post-customform.createnewrevision-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomForm" } }, "status": { "type": "integer" } } } } }, "examples": { "createCFRevisionResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-8bdb777df-dn9xf", "data": [ { "version": 17, "typedId": "406.CFO", "uniqueName": "CFO-390-REV-3", "label": "JJ_02", "parentTypedId": null, "typeId": 41, "userGroupEdit": null, "userGroupViewDetails": null, "module": "QUOTING", "results": null, "inputs": [ { "name": "input", "label": null, "lookupTableId": null, "url": null, "type": "USERENTRY", "value": 22, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": true, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": { "resultName": "input", "resultLabel": "input" }, "formattingOptions": {}, "valueOptions": null } ], "outputs": [ { "resultName": "output", "resultLabel": "input + 1", "result": 23, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "RED", "displayOptions": null, "formatType": "NUMERIC", "suffix": null, "resultType": null, "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": false, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "calculationStatus": 0, "submitDate": null, "workflowStatus": "DRAFT", "formStatus": "DRAFT", "submittedByName": null, "approvedByName": null, "deniedByName": null, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "approvalRequiredEmailAttachments": [], "renderInfo": null, "serverMessagesExtended": [], "createDate": "2023-03-02T10:40:50", "createdBy": 2147490187, "lastUpdateDate": "2023-03-02T10:40:50", "lastUpdateBy": 2147490187, "attribute1": "Approved No Approval Required CFO revision", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "customFormTypeObject": null, "supersededBy": null, "prevRev": "CFO-390-REV-2", "rootUniqueName": "CFO-390" } ], "status": 0 } } } } } } } }, "tags": [ "Custom Forms" ], "description": "Creates a new revision of the specified existing Custom Form. The returned object contains attributes, inputs or outputs, and duplicated embedded objects, but does not contain attached documents, actions, notes, and messages.
\n**Note**: The revision can only be created from a standalone Custom Form. The status of the form (`formStatus`) must be *APPROVED* and the workflow status (`workflowStatus`) must be either *APPROVED* or *NO_APPROVAL_REQUIRED*.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/add/SL": { "post": { "summary": "Add a Seller", "operationId": "post-add-SL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "addSellerResponse", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/Seller" }, "status": { "type": "integer" } } } } }, "examples": { "addSellerResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 0, "typedId": "10.SL", "sellerId": "Seller01", "name": "Acme ltd.", "userGroupEdit": "Administrators", "userGroupViewDetails": null, "reportsTo": "admin", "createDate": "2022-06-09T12:11:15", "createdBy": 2147490696, "lastUpdateDate": "2022-06-09T12:11:15", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sellers" ], "description": "Adds a seller into the Sellers Master Data table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addSellerRequest", "properties": { "data": { "type": "object", "properties": { "sellerId": { "type": "string", "description": "A unique ID of the seller." }, "name": { "type": "string", "description": "A full name of the seller, which is usually printed on documents." }, "reportsTo": { "type": "string" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true } }, "required": [ "sellerId", "name" ] }, "operation": { "type": "string" } }, "required": [ "operation" ] }, "examples": { "addSellerRequestExample": { "value": { "data": { "sellerId": "Seller01", "name": "Acme ltd.", "reportsTo": "admin", "userGroupEdit": "Administrators" }, "operation": "add" } } } } } } } }, "/sellermanager.fetchformulafilteredsellers": { "post": { "summary": "List Sellers", "operationId": "post-sellermanager.fetchformulafilteredsellers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "listSellersResponse", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "$ref": "#/components/schemas/Seller" }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listSellersResponseExample": { "value": { "response": { "node": "e2e-templates-node", "startRow": 0, "data": [ { "version": 1, "typedId": "10.SL", "sellerId": "Seller0001", "name": "Acme ltd.", "userGroupEdit": "Administrators", "userGroupViewDetails": null, "reportsTo": "admin", "createDate": "2022-06-09T12:11:15", "createdBy": 2147490696, "lastUpdateDate": "2022-06-09T13:35:36", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Sellers" ], "description": "Retrieves all sellers based on filter settings.\n\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_resultFields** response example.

\n **valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_valueFields** response example.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listSellersRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listSellersRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "name", "operator": "equals", "value": "Acme ltd." } ] } } } } } } } } }, "/update/SL": { "post": { "summary": "Update a Seller", "operationId": "post-update-SL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "updateSellerResponse", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/Seller" }, "status": { "type": "integer" } } } } }, "examples": { "updateSellerResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 1, "typedId": "10.SL", "sellerId": "Seller0001", "name": "Acme ltd.", "userGroupEdit": "Administrators", "userGroupViewDetails": null, "reportsTo": "admin", "createDate": "2022-06-09T12:11:15", "createdBy": 2147490696, "lastUpdateDate": "2022-06-09T13:35:36", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sellers" ], "description": "Updates a seller. The `version` property must be provided within the `oldValues`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateSellerRequest", "properties": { "data": { "type": "object", "properties": { "sellerId": { "type": "string" }, "typedId": { "type": "string" }, "name": { "type": "string" }, "reportsTo": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" } }, "required": [ "typedId" ] }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer", "description": "The number of version you want to update." } }, "required": [ "version" ] }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "operationType" ] }, "examples": { "updateSellerRequestExample": { "value": { "data": { "sellerId": "Seller0023", "typedId": "10.SL" }, "oldValues": { "version": 4 }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/delete/SL": { "post": { "summary": "Delete a Seller", "operationId": "post-delete-SL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "deleteSellerResponse", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/Seller" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Sellers" ], "description": "Deletes a seller from the Sellers Master Data table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteSellerRequest", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } }, "required": [ "typedId" ] } } } } } } } }, "/add/SX": { "post": { "summary": "Add a Seller Extension", "operationId": "post-add-SX", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addSellerExtensionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SX3" }, { "$ref": "#/components/schemas/SX6" }, { "$ref": "#/components/schemas/SX8" }, { "$ref": "#/components/schemas/SX10" }, { "$ref": "#/components/schemas/SX20" }, { "$ref": "#/components/schemas/SX30" }, { "$ref": "#/components/schemas/SX50" } ] }, "status": { "type": "integer" } } } } }, "examples": { "addSellerExtensionResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "3.SX3", "name": "SXTest", "sellerId": "Seller023", "createDate": "2022-06-10T12:59:50", "createdBy": 2147490696, "lastUpdateDate": "2022-06-10T12:59:50", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null } ], "status": 0 } } } } } } } }, "tags": [ "Seller Extensions" ], "description": "Adds a seller to the Seller Extensions Master Data table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addSellerExtensionRequest", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Seller Extension Category. The Category settings can be found in the following location: Administration > Configuration > Master Data > Seller Master Extension" }, "sellerId": { "type": "string" } }, "required": [ "name", "sellerId" ] }, "operation": { "type": "string" } }, "required": [ "operation" ] }, "examples": { "addSellerExtensionRequestExample": { "value": { "data": { "name": "SXTest", "sellerId": "Seller023" }, "operation": "add" } } } } } } } }, "/sellermanager.fetch/{SellerId}/SX/{SXCategory}": { "parameters": [ { "schema": { "type": "string", "example": "SC-001" }, "name": "SellerId", "in": "path", "required": true, "description": "The `SellerId` of the seller in the Seller Extension table you want to retrieve details for." }, { "schema": { "type": "string", "example": "SalesOrganization" }, "name": "SXCategory", "in": "path", "required": true, "description": "The Seller Extension category (the `Name` from the *Seller Master Extension* table)." } ], "post": { "summary": "Get a Seller Extension", "operationId": "post-sellermanager.fetch-SellerId-SX-SXCategory", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "getSellerExtensionResponse", "properties": { "status": { "type": "integer" }, "node": { "type": "string" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SX3" }, { "$ref": "#/components/schemas/SX6" }, { "$ref": "#/components/schemas/SX8" }, { "$ref": "#/components/schemas/SX10" }, { "$ref": "#/components/schemas/SX20" }, { "$ref": "#/components/schemas/SX30" }, { "$ref": "#/components/schemas/SX50" } ] }, "endRow": { "type": "integer" } } } } }, "examples": { "getSellerExtensionResponseExample": { "value": { "repsonse": { "status": 0, "node": "node", "data": [ { "version": 2, "typedId": "1.SX3", "name": "SXTest", "sellerId": "Seller001", "createDate": "2022-06-09T12:08:49", "createdBy": 2147490696, "lastUpdateDate": "2022-06-14T12:56:57", "lastUpdateBy": 2147490696, "attribute1": "123", "attribute2": null, "attribute3": null } ], "endRow": 1 } } } } } } } }, "tags": [ "Seller Extensions" ], "description": "Retrieves details of the specified Seller Extension." } }, "/sellermanager.fetch/*/SX/{SXCategory}": { "parameters": [ { "schema": { "type": "string", "example": "SalesOrganization" }, "name": "SXCategory", "in": "path", "required": true, "description": "The Seller Extension category (the `Name` from the *Seller Master Extension* table)." } ], "post": { "summary": "List Seller Extensions", "operationId": "post-sellermanager.fetch-*-SX-SXCategory", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "getSellerExtensionResponse", "properties": { "status": { "type": "integer" }, "node": { "type": "string" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SX3" }, { "$ref": "#/components/schemas/SX6" }, { "$ref": "#/components/schemas/SX8" }, { "$ref": "#/components/schemas/SX10" }, { "$ref": "#/components/schemas/SX20" }, { "$ref": "#/components/schemas/SX30" }, { "$ref": "#/components/schemas/SX50" } ] }, "endRow": { "type": "integer" } } } } }, "examples": { "getSellerExtensionResponseExample": { "value": { "response": { "status": 0, "node": "node", "data": [ { "version": 2, "typedId": "1.SX3", "name": "SXTest", "sellerId": "Seller001", "createDate": "2022-06-09T12:08:49", "createdBy": 2147490696, "lastUpdateDate": "2022-06-14T12:56:57", "lastUpdateBy": 2147490696, "attribute1": "123", "attribute2": null, "attribute3": null } ], "endRow": 1 } } } } } } } }, "tags": [ "Seller Extensions" ], "description": "Retrieves all Seller Extensions.

\nYou can choose fields to be returned in the response by employing the `resultFields` or `valueFields` filter:
\n**resultFields**: returns key-value pairs as objects. This is the more friendly response compared to *valueFields* but the server fetches all fields from the database in the backend which might result in a slower performance. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_resultFields** response example.

\n**valueFields**: returns just an array of values. Use this option if a better performance is required. See the [List Customers](https://api.pricefx.com/openapi/reference/pricefx/operation/post-customermanager.fetchformulafilteredcustomers/)' **listCustomersResponseExample_valueFields** response example." } }, "/update/SX": { "post": { "summary": "Update a Seller Extension", "operationId": "post-update-SX", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "updateSellerExtensionResponse", "properties": { "node": { "type": "string" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SX3" }, { "$ref": "#/components/schemas/SX6" }, { "$ref": "#/components/schemas/SX8" }, { "$ref": "#/components/schemas/SX10" }, { "$ref": "#/components/schemas/SX20" }, { "$ref": "#/components/schemas/SX30" }, { "$ref": "#/components/schemas/SX50" } ] }, "status": { "type": "integer" } } } } }, "examples": { "updateSellerExtensionResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 1, "typedId": "4.SX3", "name": "SXTest", "sellerId": "Seller024", "createDate": "2022-06-14T12:57:21", "createdBy": 2147490696, "lastUpdateDate": "2022-06-15T10:49:19", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null } ], "status": 0 } } } } } } } }, "tags": [ "Seller Extensions" ], "description": "Updates `sellerId` of the specified Seller Extension. The `version` property must be provided within the `oldValues`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sellerId": { "type": "string" }, "typedId": { "type": "string" } }, "required": [ "sellerId", "typedId" ] }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "name": { "type": "string" }, "sellerId": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "attribute1": { "type": "string", "nullable": true }, "attribute2": { "type": "string", "nullable": true }, "attribute3": { "type": "string", "nullable": true } }, "required": [ "version" ] }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "operationType" ] }, "examples": { "updateSellerExtensionRequestExample": { "value": { "data": { "sellerId": "Seller024", "typedId": "4.SX3" }, "oldValues": { "version": 0, "typedId": "4.SX3", "name": "SXTest", "sellerId": "Seller0233", "createDate": "2022-06-14T12:57:21", "createdBy": 2147490696, "lastUpdateDate": "2022-06-14T12:57:21", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/delete/SX": { "post": { "summary": "Delete a Seller Extension", "operationId": "post-delete-SX", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteSellerExtensionResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SX3" }, { "$ref": "#/components/schemas/SX6" }, { "$ref": "#/components/schemas/SX8" }, { "$ref": "#/components/schemas/SX10" }, { "$ref": "#/components/schemas/SX20" }, { "$ref": "#/components/schemas/SX30" }, { "$ref": "#/components/schemas/SX50" } ] }, "status": { "type": "integer" } } } } }, "examples": { "deleteSellerExtensionResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 1, "typedId": "4.SX3", "name": "SXTest", "sellerId": "Seller024", "createDate": "2022-06-14T12:57:21", "createdBy": 2147490696, "lastUpdateDate": "2022-06-15T10:49:19", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null } ], "status": 0 } } } } } } } }, "tags": [ "Seller Extensions" ], "description": "Deletes the specified (by `typedId` in the payload) Seller Extension.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteSellerExtensionRequest", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "description": "`typedId` of the Seller Extension you want to delete." } } } } } } } } } }, "/add/COHT": { "post": { "summary": "Add a Compensation Type", "operationId": "post-add-COHT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "addCompensationTypeResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationHeaderType" } }, "status": { "type": "integer" } } } } }, "examples": { "addCompensationTypeResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "53.COHT", "uniqueName": "The Test Compensation Type", "label": null, "userGroupEdit": null, "userGroupViewDetails": null, "headerFormulaName": "SC_CompensationHeader", "workflowFormulaName": "SC_SalesCompensationAgreement", "configuration": null, "scTypeFilterFormulaName": null, "scRecordWorkflowFormulaName": "SC_AgreementRecord", "createDate": "2022-06-16T15:43:16", "createdBy": 1687, "lastUpdateDate": "2022-06-16T15:43:16", "lastUpdateBy": 1687, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Creates a Compensation Type record in the Compensation Header Types table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addCompensationTypeRequest", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string", "description": "A unique identification of this type. This name will be used in the Compensation Plan document as a foreign key, to identify the Compensation Header Type used." }, "headerFormulaName": { "type": "string", "description": "A name of the logic used for building inputs and calculating results for the Compensation Plan header, but can also manipulate the items and folders." }, "workflowFormulaName": { "type": "string", "description": "A name of the approval workflow logic, which will build the approval steps for the Compensation Plan document." }, "configuration": { "type": "string", "description": "A configuration (as JSON string) of the detail page. You can configure e.g., the additional tabs on Compensation Plan detail page, which will show information in form of a dashboard.", "nullable": true }, "scRecordWorkflowFormulaName": { "type": "string", "description": "A name of the approval workflow logic, which will build the approval steps for the compensation records." }, "scTypeFilterFormulaName": { "type": "string", "description": "A name of the logic which will be used to filter the available Compensation Condition Types, while the user is adding a new item to the Compensation Plan document." } }, "required": [ "uniqueName" ] }, "operation": { "type": "string" } }, "required": [ "operation" ] }, "examples": { "addCompensationTypeRequestExample": { "value": { "data": { "uniqueName": "The Test Compensation Type", "headerFormulaName": "SC_CompensationHeader", "workflowFormulaName": "SC_SalesCompensationAgreement", "configuration": null, "scRecordWorkflowFormulaName": "SC_AgreementRecord" }, "operation": "add" } } } } } } } }, "/fetch/COHT": { "post": { "summary": "List Compensation Types", "operationId": "post-fetch-COHT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "listCompensationTypesResponse", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationHeaderType" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listCompensationTypesResponseExample": { "value": { "response": { "node": "node1", "startRow": 0, "data": [ { "version": 0, "typedId": "54.COHT", "uniqueName": "The Test Compensation Type 2", "headerFormulaName": "SC_CompensationHeader", "workflowFormulaName": "SC_SalesCompensationAgreement", "configuration": {}, "scRecordWorkflowFormulaName": "SC_AgreementRecord", "createDate": "2022-06-17T10:14:15", "createdBy": 1687, "lastUpdateDate": "2022-06-17T10:14:15", "lastUpdateBy": 1687 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Retrieves Compensation Types from the Compensation Header Types table. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCompensationTypesRequest", "properties": { "endRow": { "type": "integer" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listCompensationTypesRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "uniqueName", "operator": "iEquals", "value": "The Test Compensation Type" } ] } } } } } } } } }, "/update/COHT": { "post": { "summary": "Update a Compensation Type", "operationId": "post-update-COHT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "updateCompensationTypeResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationHeaderType" } }, "status": { "type": "integer" } } } } }, "examples": { "updateCompensationTypeResponseExample": { "value": { "response": { "node": "string", "data": [ { "configuration": { "additionalProperties": {} }, "createDate": "2019-08-24T14:15:22Z", "createdBy": 0, "headerFormulaName": "string", "label": "string", "lastUpdateBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "scRecordWorkflowFormulaName": "string", "scTypeFilterFormulaName": "string", "typedId": "string", "uniqueName": "string", "userGroupEdit": "string", "userGroupViewDetails": "string", "version": 0, "workflowFormulaName": "string", "attribute1": "string", "attribute2": "string", "attribute3": "string", "attribute4": "string", "attribute5": "string", "attribute6": "string", "attribute7": "string", "attribute8": "string", "attribute9": "string", "attribute10": "string", "attribute11": "string", "attribute12": "string", "attribute13": "string", "attribute14": "string", "attribute15": "string", "attribute16": "string", "attribute17": "string", "attribute18": "string", "attribute19": "string", "attribute20": "string", "attribute21": "string", "attribute22": "string", "attribute23": "string", "attribute24": "string", "attribute25": "string", "attribute26": "string", "attribute27": "string", "attribute28": "string", "attribute29": "string", "attribute30": "string" } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Updates a Compensation Type in the Compensation Header Types table. The `version` property must be provided within the `oldValues`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCompensationTypeRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" }, "headerFormulaName": { "type": "string" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "headerFormulaName": { "type": "string" }, "workflowFormulaName": { "type": "string" }, "configuration": { "type": "object" }, "scRecordWorkflowFormulaName": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } }, "required": [ "version" ] }, "operationType": { "type": "string", "example": "update" }, "textMatchStyle": { "type": "string" } }, "required": [ "data", "operationType" ] }, "examples": { "updateCompensationTypeRequestExample": { "value": { "data": { "headerFormulaName": "SC_CompensationHeader2", "typedId": "54.COHT" }, "oldValues": { "version": 0, "typedId": "54.COHT", "uniqueName": "The Test Compensation Type 2", "headerFormulaName": "SC_CompensationHeader", "workflowFormulaName": "SC_SalesCompensationAgreement", "configuration": {}, "scRecordWorkflowFormulaName": "SC_AgreementRecord", "createDate": "2022-06-17T10:14:15", "createdBy": 1687, "lastUpdateDate": "2022-06-17T10:14:15", "lastUpdateBy": 1687 }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/delete/COHT": { "post": { "summary": "Delete a Compensation Type", "operationId": "post-delete-COHT", "responses": { "200": { "description": "OK - returns the deleted object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationHeaderType" } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "node1", "data": [ { "version": 1, "typedId": "54.COHT", "uniqueName": "The Test Compensation Type 2", "label": null, "userGroupEdit": null, "userGroupViewDetails": null, "headerFormulaName": "SC_CompensationHeader", "workflowFormulaName": "SC_SalesCompensationAgreement", "configuration": null, "scTypeFilterFormulaName": null, "scRecordWorkflowFormulaName": "SC_AgreementRecord", "createDate": "2022-06-17T10:14:15", "createdBy": 1687, "lastUpdateDate": "2022-06-17T12:20:40", "lastUpdateBy": 1687, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "deleteCompensationTypeRequestExample": { "value": { "data": { "typedId": "54.COHT" } } } } } } }, "description": "Deletes a Compensation Type from the Compensation Header Types table." } }, "/add/COCT": { "post": { "summary": "Add a Condition Type", "operationId": "post-add-COCT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "addConditionTypeResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationConditionType" } }, "status": { "type": "integer" } } } } }, "examples": { "addConditionTypeResponseExample": { "value": { "response": { "node": "node1", "data": [ { "version": 0, "typedId": "47.COCT", "uniqueName": "SingleTargetAmount", "label": "Single Target Amount", "userGroupEdit": null, "userGroupViewDetails": null, "formulaName": "SC_Compensation", "waterfallElement": null, "createDate": "2022-06-17T14:24:28", "createdBy": 1687, "lastUpdateDate": "2022-06-17T14:24:28", "lastUpdateBy": 1687, "attribute1": "Header Level", "attribute2": null, "attribute3": "Annually", "attribute4": "Fixed Amount", "attribute5": 2, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": "Annual", "attribute10": null, "attribute11": "Non-Cumulative", "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addConditionTypeRequest", "properties": { "data": { "$ref": "#/components/schemas/CompensationConditionType" }, "operationType": { "type": "string" } } }, "examples": { "addConditionTypeRequestExample": { "value": { "data": { "uniqueName": "SingleTargetAmount", "label": "Single Target Amount", "formulaName": "SC_Compensation", "attribute1": "Header Level", "attribute3": "Annually", "attribute4": "Fixed Amount", "attribute5": 2, "attribute9": "Annual", "attribute11": "Non-Cumulative" }, "operationType": "add" } } } } }, "description": "" }, "description": "Creates a Condition Type record in the Compensation Condition Types table." } }, "/fetch/COCT": { "post": { "summary": "List Condition Types", "operationId": "post-fetch-COCT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "listConditionTypesResponse", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationConditionType" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listConditionTypesResponseExample": { "value": { "response": { "node": "node1", "startRow": 0, "data": [ { "version": 0, "typedId": "47.COCT", "uniqueName": "SingleTargetAmount", "label": "Single Target Amount", "formulaName": "SC_Compensation", "createDate": "2022-06-17T14:24:28", "createdBy": 1687, "lastUpdateDate": "2022-06-17T14:24:28", "lastUpdateBy": 1687, "attribute1": "Header Level", "attribute3": "Annually", "attribute4": "Fixed Amount", "attribute5": 2, "attribute9": "Annual", "attribute11": "Non-Cumulative" } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listConditionTypesRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "integer" } } } } } } } } } } }, "description": "Retrieves one or more (based on filter settings) Condition Types from the Compensation Condition Types table." } }, "/update/COCT": { "post": { "summary": "Update a Condition Type", "operationId": "post-update-COCT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "updateConditionTypeResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationConditionType" } }, "status": { "type": "integer" } } } } }, "examples": { "updateConditionTypeResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 3, "typedId": "18.COCT", "uniqueName": "test_updated", "label": "test - updated", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers", "formulaName": null, "waterfallElement": null, "createDate": "2022-06-20T09:46:41", "createdBy": 2147490696, "lastUpdateDate": "2022-06-21T12:01:38", "lastUpdateBy": 2147490696, "attribute1": 2022, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Updates a Condition Type in the Compensation Condition Types table. The `version` property must be provided within the `oldValues`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateConditionTypeRequest", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string" }, "label": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "typedId": { "type": "string" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "formulaName": { "type": "string", "nullable": true }, "waterfallElement": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "attribute1": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute2": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute3": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute4": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute5": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute6": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute7": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute8": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute9": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute10": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute11": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute12": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute13": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute14": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute15": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute16": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute17": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute18": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute19": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute20": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute21": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute22": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute23": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute24": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute25": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute26": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute27": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute28": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute29": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute30": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] } }, "required": [ "version" ] }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "data" ] }, "examples": { "updateConditionTypeRequestExample": { "value": { "data": { "uniqueName": "test_updated", "label": "test - updated", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers", "typedId": "18.COCT" }, "oldValues": { "version": 2, "typedId": "18.COCT", "uniqueName": "test", "label": "test", "userGroupEdit": null, "userGroupViewDetails": null, "formulaName": null, "waterfallElement": null, "createDate": "2022-06-20T09:46:41", "createdBy": 2147490696, "lastUpdateDate": "2022-06-21T09:31:35", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/delete/COCT": { "post": { "summary": "Delete a Condition Type", "operationId": "post-delete-COCT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "deleteConditionTypeResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationConditionType" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteConditionTypeResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 3, "typedId": "18.COCT", "uniqueName": "test_updated", "label": "test - updated", "userGroupEdit": "Administrators", "userGroupViewDetails": "PricingManagers", "formulaName": null, "waterfallElement": null, "createDate": "2022-06-20T09:46:41", "createdBy": 2147490696, "lastUpdateDate": "2022-06-21T15:59:37", "lastUpdateBy": 2147490696, "attribute1": 2022, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Deletes a Condition Type from the Compensation Condition Types table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteConditionTypeRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "example": "23.COCT" } } } }, "required": [ "data" ] }, "examples": { "deleteConditionTypeRequestExample": { "value": { "data": { "typedId": "23.COCT" } } } } } } } } }, "/compensation.save": { "post": { "summary": "Upsert a Compensation Plan", "operationId": "post-compensation.save", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "upsertCompensationPlanResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "integer" } } } } }, "examples": { "upsertCompensationPlanResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 4, "typedId": "6.CO", "uniqueName": "CO-6", "label": "New Compensation Plan", "targetDate": "2022-06-22", "workflowStatus": "DRAFT", "headerText": null, "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Compensation Plan calculated successfully" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "sellerGroup": null, "customerGroup": null, "startDate": "2022-06-22", "endDate": "2022-06-22", "payoutDate": "2022-06-22", "compensationRecordSetId": null, "compensationRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "compensationStatus": "DRAFT", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "approvalRequiredEmailAttachmentsJson": null, "renderInfo": null, "serverMessagesExtended": [ { "key": null, "message": "Compensation Plan calculated successfully" } ], "approvedByName": null, "deniedByName": null, "hasWorkflowHistory": false, "createDate": "2022-06-22T08:33:41", "createdBy": 2147490696, "lastUpdateDate": "2022-06-22T08:33:41", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "CO-6", "compensationHeaderType": null } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Creates or updates a Compensation Plan. Assigns new `uniqueName` when a new Compensation Plan is created. To update a Compensation Plan, specify the existing `uniqueName`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "upsertCompensationPlanRequest", "properties": { "data": { "type": "object", "properties": { "compensation": { "$ref": "#/components/schemas/Compensation" } } } } }, "examples": { "upsertCompensationPlanRequestExample": { "value": { "data": { "compensation": { "inputs": [ { "label": "Customer(s)", "name": "CustomerGroup", "type": "CUSTOMERGROUP" }, { "label": "Product(s)", "name": "ProductGroup", "type": "PRODUCTGROUP" } ], "outputs": [], "lineItems": [], "label": "New Compensation Plan", "nodeId": 0, "compensationHeaderType": null, "userGroupEdit": null, "userGroupViewDetails": null, "startDate": "2022-06-22", "endDate": "2022-06-22", "targetDate": null, "externalRef": null, "viewState": {} } } } } } } } } }, "parameters": [] }, "/fetch/CO": { "post": { "summary": "List Compensation Plans", "tags": [ "Sales Compensations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCompensationPlansResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listSalesCompensationsResponseExample": { "value": { "response": { "node": "node1", "csrfToken": "token", "startRow": 0, "data": [ { "version": 6, "typedId": "1.CO", "uniqueName": "CO-1", "label": "New Compensation Plan", "targetDate": "2022-04-28", "workflowStatus": "DRAFT", "lastUpdateByName": "billy.graham", "createdByName": "billy.graham", "calculationStatus": 0, "dirty": true, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "startDate": "2022-04-28", "endDate": "2022-04-28", "payoutDate": "2022-04-28", "status": "DRAFT", "compensationStatus": "DRAFT", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "hasWorkflowHistory": false, "createDate": "2022-04-28T09:58:56", "createdBy": 492, "lastUpdateDate": "2022-04-28T14:07:04", "lastUpdateBy": 492, "rootUniqueName": "CO-1" }, { "version": 143, "typedId": "9.CO", "uniqueName": "CO-9", "label": "Test Migration", "targetDate": "2022-05-09", "workflowStatus": "SUBMITTED", "lastUpdateByName": "tram1", "createdByName": "tram1", "submittedByName": "tram1", "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "startDate": "2022-01-01", "endDate": "2022-12-31", "payoutDate": "2022-05-09", "status": "DRAFT", "compensationStatus": "DRAFT", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]", "hasWorkflowHistory": true, "approvedByName": "tram1", "createDate": "2022-05-09T06:20:21", "createdBy": 290, "lastUpdateDate": "2022-05-11T07:42:22", "lastUpdateBy": 290, "rootUniqueName": "CO-9", "compensationHeaderType": "[SC] Direct Compensation" }, { "version": 60, "typedId": "15.CO", "uniqueName": "CO-15", "label": "Test migration 2", "targetDate": "2022-05-11", "workflowStatus": "DRAFT", "lastUpdateByName": "tram1", "createdByName": "tram1", "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "numberOfAttachments": 0, "sellerGroup": { "sellerFilterCriteria": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "sellerId", "operator": "inSet", "value": [ "SC-006" ] } ], "operator": "and" } }, "customerGroup": { "label": "B (Customer Class)", "customerFieldName": "attribute3", "customerFieldLabel": "Customer Class", "customerFieldValue": "B" }, "startDate": "2022-01-01", "endDate": "2022-12-31", "payoutDate": "2022-05-11", "status": "DRAFT", "compensationStatus": "DRAFT", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "hasWorkflowHistory": false, "createDate": "2022-05-11T09:02:59", "createdBy": 290, "lastUpdateDate": "2022-05-13T08:05:05", "lastUpdateBy": 290, "rootUniqueName": "CO-15", "compensationHeaderType": "[SC] Direct Compensation" } ], "endRow": 3, "totalRows": 92, "status": 0 } } } } } } } }, "operationId": "post-fetch-CO", "description": "Retrieves Compensation Plans. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCompensationPlansRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listSalesCompensationsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "workflowStatus", "operator": "equals", "value": "SUBMITTED" } ] } } } } } } } } }, "/clicmanager.fetch/{typedId}": { "post": { "summary": "List CLIC Objects", "operationId": "post-clicmanager.fetch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getCLICresponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "typedId": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "properties": { "sortType": { "type": "string" }, "validationType": { "type": "string" }, "dataType": { "type": "string" } } }, "formattingOptions": { "type": "object" }, "value": { "anyOf": [ { "properties": { "100": { "type": "string" }, "150": { "type": "string" }, "0.4": { "type": "string" }, "1.6": { "type": "string" }, "2.71": { "type": "string" } } } ], "type": "object" }, "valueHint": { "type": "string" }, "required": { "type": "boolean" }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "displayOptions": { "type": "integer" }, "resultType": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideAllowEmpty": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overridable": { "type": "boolean" } } } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "payoutDate": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object" } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "object" } }, "dateDimFieldName": { "type": "string" } } }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "compensationConditionType": { "type": "string" }, "compensationConditionTypeLabel": { "type": "string" } } } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Clicmanager", "Quotes", "Rebate Agreements", "Sales Compensations", "Contracts (Agreements & Promotions)" ], "description": "Retrieves line items of the specified CLIC entity (Quote/Contract/Rebate Agreement/Compensation Plan Line Items).\n

\n\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getCLICrequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "operator": { "type": "string" }, "_constructor": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" } } } } } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/noComplexResults" }, { "schema": { "type": "boolean" }, "in": "query", "name": "getMyItemsForReview", "description": "The parameter is allowed only if Creation workflow is in Review step.
- if set to `true` - the line items assigned to a line item group in the Review step of the Creation workflow are returned.
- if set to `false` - the line items from other line item groups are returned." } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Quote/Contract/Rebate Agreement/Compensation Plan you want to retrieve line items for." } ] }, "/clicmanager.update/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Compensation Plan you want to update." } ], "post": { "summary": "Update a Quote/Contract/Rebate Agreement/Compensation Plan", "tags": [ "Sales Compensations", "Clicmanager" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Quote" }, { "$ref": "#/components/schemas/Compensation" }, { "$ref": "#/components/schemas/Contract" }, { "$ref": "#/components/schemas/RebateAgreement" } ] } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "string", "data": [ { "outputs": [ { "resultName": "string", "resultLabel": "string", "result": {}, "excludeFromExport": true, "warnings": [ "string" ], "alertMessage": "string", "alertType": "CRITICAL", "displayOptions": 0, "formatType": "NUMERIC", "suffix": "string", "resultType": "string", "cssProperties": "string", "userGroup": "string", "resultGroup": "string", "overrideValueOptions": [ null ], "overrideAllowEmpty": true, "labelTranslations": "string", "overridable": true, "overridden": true, "resultDescription": "string" } ], "createdByName": "string", "typedId": "string", "headerText": "string", "successfulCalculationMsg": "SUCCESS", "endDate": null, "workflowStatus": "DRAFT", "inputs": [ { "name": "string", "label": "string", "lookupTableId": "string", "url": "string", "type": "string", "value": {}, "valueHint": "string", "readOnly": true, "filter": { "property1": {}, "property2": {} }, "parameterGroup": "string", "required": true, "labelTranslations": "string", "addUnknownValues": true, "typedId": "string", "alwaysEditable": true, "inputs": [ {} ], "parameterConfig": { "property1": {}, "property2": {} }, "formattingOptions": { "property1": {}, "property2": {} }, "valueOptions": [ "string" ] } ], "lastUpdateDate": "2019-08-24T14:15:22Z", "readOnlyLineItemClass": "string", "compensationHeaderType": "string", "serverMessagesExtended": [ { "key": "string", "message": "string" } ], "compensationRecordSetLabel": "string", "payoutDate": null, "deniedByName": "string", "lineItems": [ { "version": 0, "typedId": "string", "clicId": 0, "inputs": [ {} ], "outputs": [ {} ], "dirty": true, "lineId": "string", "parentId": "string", "calculationStatus": 0, "editabilityStatus": 0, "label": "string", "containsProductImage": true, "customerGroup": { "label": "string", "customerFieldName": "string", "customerFieldLabel": "string", "customerFieldValue": "string", "customerFilterCriteria": { "property1": {}, "property2": {} } }, "productGroup": { "label": "string", "productFieldName": "string", "productFieldLabel": "string", "productFieldValue": "string", "productFilterCriteria": { "property1": {}, "property2": {} } }, "startDate": null, "endDate": null, "payoutDate": "2019-08-24T14:15:22Z", "calculationBaseJson": "string", "calculationBase": { "includedCustomerGroups": [ {} ], "includedProductGroups": [ {} ], "includedSellerReferences": [ { "sellerId": "string", "sellerName": "string" } ], "excludedCustomerGroups": [ {} ], "excludedproductGroups": [ {} ], "excludedSellerReferences": [ {} ], "includedTimePeriods": [ { "timeUnit": "DAY", "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "single": true } ], "excludedTimePeriods": [ {} ], "otherFilters": [ 0 ], "dateDimFieldName": "string" }, "simulationType": "string", "folder": true, "treeLabel": "string", "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0, "compensationConditionType": "string", "compensationConditionTypeLabel": "string" } ], "userGroupViewDetails": "string", "approvedByName": "string", "creationWorkflowCurrentStep": 0, "rootUniqueName": "string", "targetDate": "2019-08-24T14:15:22Z", "customerGroup": {}, "ioMeta": "string", "version": 0, "uniqueName": "string", "serverMessages": [ "string" ], "creationWorkflowStatus": "DRAFT", "userGroupEdit": "string", "conditionTypeClass": "string", "hasWorkflowHistory": true, "nodeId": 0, "startDate": null, "status": "DRAFT", "lastUpdateByName": "string", "renderInfo": { "property1": {}, "property2": {} }, "signature": { "envelopeId": "string", "status": "sent", "sentDateTime": 0, "statusChangedDateTime": 0, "customerName": "string", "customerUserOrEmail": "string", "sender": 0, "senderName": "string", "templateName": "string", "note": "string", "voidedReason": "string", "error": "string", "history": [ {} ] }, "creationWorkflowStepCount": 0, "sellerGroup": 0, "compensationRecordSetId": 0, "creationWorkflowStepLabel": "string", "formulaElementGroupReadOnly": "string", "submittedByName": "string", "formulaElementGroup": "string", "createDate": "2019-08-24T14:15:22Z", "dirty": true, "additionalInfo4": "string", "additionalInfo3": "string", "refreshInputs": true, "additionalInfo2": 0, "additionalInfo1": 0, "numberOfAttachments": 0, "compensationStatus": "DRAFT", "simulationType": "string", "label": "string", "nextRevUNs": [ "string" ], "simulationSet": "string", "createdBy": 0, "calculationWithErrorsMsg": "SUCCESS", "approvalRequiredEmailAttachmentsJson": "string", "viewState": { "gridViewState": "string", "openFolders": [ "string" ], "selectedNodes": [ "string" ] }, "prevRev": "string", "calculationStatus": 0, "supersededBy": "string", "lastUpdateBy": 0 } ], "status": 0 } } } } } } } }, "operationId": "post-clicmanager.update-typedId", "description": "Updates a Quote, Contract, Rebate Agreement, or Compensation Plan.
\n`attributeExtension` can be updated as follows:
\n```json\n{\n \"data\": {\n \"typedId\": \"{typedId}\",\n \"version\": {version},\n \"attributeExtension___AttributeExtensionColumn2\": \"testValue\"\n }\n }\n```\n

\n\n>This endpoint is not allowed to modify the document status and workflow status.\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/Quote" }, { "$ref": "#/components/schemas/Compensation" }, { "$ref": "#/components/schemas/Contract" }, { "$ref": "#/components/schemas/RebateAgreement" } ] } } }, "examples": { "updateCLICRequestExample": { "value": { "data": { "version": 10, "typedId": "8.CO", "uniqueName": "CO-8", "label": "New Compensation Plan", "targetDate": "2022-06-22", "workflowStatus": "DRAFT", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": { "customerFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "customerId", "operator": "inSet", "value": [ "001", "00001" ] } ] }, "label": "001,00001" }, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": true, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "sellerGroup": null, "customerGroup": null, "startDate": "2022-06-22", "endDate": "2022-06-22", "payoutDate": "2022-06-22", "compensationRecordSetId": null, "compensationRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "compensationStatus": "DRAFT", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "approvalRequiredEmailAttachmentsJson": null, "renderInfo": null, "serverMessagesExtended": null, "approvedByName": null, "deniedByName": null, "hasWorkflowHistory": false, "createDate": "2022-06-22T11:44:40", "createdBy": 2147490696, "lastUpdateDate": "2022-06-22T11:55:08", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "CO-8", "ioMeta": { "inputs": {}, "outputs": {} }, "compensationHeaderType": null, "headerText": "

testno

" } } } } } } } } }, "/delete/CO": { "post": { "summary": "Delete a Compensation Plan", "operationId": "post-delete-CO", "responses": { "200": { "description": "OK. Returns the deleted Compensation Plan object.", "content": { "application/json": { "schema": { "type": "object", "title": "deleteCompensationPlanResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Deletes a Compensation Plan.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteCompensationPlanRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "example": "123.CO" } } } }, "required": [ "data" ] } } } } } }, "/compensation.copy/{typedId}": { "post": { "summary": "Duplicate a Compensation Plan", "description": "Creates a copy of the specified Compensation Plan.", "operationId": "post-compensation.copy", "responses": { "200": { "description": "OK. Returns the duplicated object.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Sales Compensations" ] }, "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Compensation Plan you want to duplicate." } ] }, "/clicmanager.calculate/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the document you want to calculate." } ], "post": { "summary": "Recalculate a Quote/Contract/Rebate Agreement/Compensation Plan", "operationId": "post-clicmanager.calculate-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string" }, "createdByName": { "type": "string" }, "typedId": { "type": "string" }, "workflowStatus": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "value": { "type": "object", "properties": { "Helptext": { "type": "string" }, "Title": { "type": "string" }, "helplink": { "type": "string" }, "Placeholder": { "type": "string" }, "CustAttrName": { "type": "string" }, "CustAttrValue": { "type": "string" }, "Exportable": { "type": "boolean" }, "Importable": { "type": "boolean" }, "Configurator": { "type": "object" }, "InlineConfigurator": { "type": "object", "properties": { "Checkbox1": { "type": "boolean" } } }, "InputMatrix": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "comment": { "type": "string" }, "oneof": { "type": "string" } } } }, "Option": { "type": "string" }, "Options": { "type": "string" } } } } } }, "lastUpdateDate": { "type": "string" }, "serverMessagesExtended": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" } } } }, "quoteType": { "type": "string" }, "quoteStatus": { "type": "string" }, "expiryDate": { "type": "string" }, "createDate": { "type": "string" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "rootUniqueName": { "type": "string" }, "numberOfAttachments": { "type": "integer" }, "targetDate": { "type": "string" }, "ioMeta": { "type": "object", "properties": { "inputs": { "type": "object" }, "outputs": { "type": "object" } } }, "originDeleted": { "type": "boolean" }, "label": { "type": "string" }, "version": { "type": "integer" }, "uniqueName": { "type": "string" }, "serverMessages": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "integer" }, "viewState": { "type": "object" }, "calculationStatus": { "type": "integer" }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string" }, "folderChanged": { "type": "boolean", "description": "Returns `true` when a folder is added, renamed, deleted, or moved." }, "inputChanged": { "type": "array", "description": "Returns `lineId` when an input is added, or updated by a header logic.", "items": { "type": "string" } }, "outputChanged": { "type": "array", "description": "Returns `lineId` when an output is added, or updated by a header logic.", "items": { "type": "string" } }, "durations": { "type": "object", "description": "Stats result of the currently performed calculation.", "properties": { "header": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "duration": { "type": "integer" } } } }, "items": { "type": "array", "items": { "type": "object" } } } } } } }, "status": { "type": "integer" } } } } }, "examples": { "recalculateCLICResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ { "outputs": [], "lastUpdateByName": "ondrej.tesar", "createdByName": "petr.rys", "typedId": "2147493280.Q", "workflowStatus": "DRAFT", "inputs": [ { "name": "Customer", "label": "Customer", "url": "/fetch/C/", "type": "CUSTOMER", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "InlineCOnfiguratorWithInputs", "label": "Inline Configurator With All Inputs", "url": "InputsAllAvailableInConfiguratorBasic", "type": "INLINECONFIGURATOR", "value": { "Helptext": "helptext", "Title": "title", "helplink": "https://www.pricefx.com", "Placeholder": "Placeholder", "CustAttrName": "Attribute name", "CustAttrValue": "Attribute Value", "Exportable": true, "Importable": true, "Configurator": {}, "InlineConfigurator": { "Checkbox1": true }, "InputMatrix": [ { "name": "A", "comment": "A1", "oneof": "YYYY" }, { "name": "B", "comment": "B1" }, { "name": "C", "comment": "C1" } ], "Option": "Value", "Options": "A" }, "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "lastUpdateDate": "2022-12-22T09:36:54", "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully" } ], "quoteType": "All Inputs Header Configurator Basic", "quoteStatus": "DRAFT", "expiryDate": "2023-01-01", "createDate": "2022-12-01T10:06:01", "dirty": false, "refreshInputs": false, "rootUniqueName": "P-2147493280", "numberOfAttachments": 0, "targetDate": "2022-12-01", "ioMeta": { "inputs": {}, "outputs": {} }, "originDeleted": false, "label": "New Quote", "version": 13, "uniqueName": "P-2147493280", "serverMessages": [ "Quote calculated successfully" ], "createdBy": 2147483724, "viewState": {}, "calculationStatus": 0, "hasWorkflowHistory": false, "nodeId": 0, "lastUpdateBy": 2147490187, "status": "DRAFT" }, { "folderChanged": false, "inputChanged": [ "ROOT" ], "outputChanged": [], "durations": { "header": [ { "name": "pre", "duration": 21 }, { "name": "post", "duration": 3 } ], "items": [] } } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations", "Clicmanager" ], "description": "Calculates a Quote, Contract, Rebate Agreement, or Compensation Plan.

\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.\n", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "validationType", "description": "Configures user inputs validation (if all required fields are filled in) when a quote or contract is recalculated.

Possible values:
`none` – Disables the validation.
`strict` – Prevents the action to be executed if the validation fails." } ] } }, "/add/CORSC": { "post": { "summary": "Add a Calculation", "operationId": "post-add-CORSC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecordSetCalculation" } }, "status": { "type": "integer" } } } } }, "examples": { "addCalculationResponseExample": { "value": { "response": { "node": "node1", "data": [ { "version": 0, "typedId": "8.CORSC", "targetDate": null, "label": "SC_records", "locale": null, "calculationMessages": null, "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "compensationRecordSet": { "version": 0, "typedId": "1.CORS", "targetDate": null, "label": "Sales Compensations", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "userGroupEdit": null, "userGroupViewDetails": null, "updatedBy": 119, "updateDate": "2022-05-05", "recordSetId": 1, "createDate": "2022-05-05T11:36:03", "createdBy": 119, "lastUpdateDate": "2022-05-05T11:36:03", "lastUpdateBy": 119, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 1 }, "dtoFilter": null, "sortBy": null, "calculationType": null, "adhocCalculation": null, "calculationConfig": null, "createDate": "2022-06-24T09:12:39", "createdBy": 1687, "lastUpdateDate": "2022-06-24T09:12:39", "lastUpdateBy": 1687, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "isDefault": false, "incremental": true, "incCalculationDate": null, "shouldSubmit": false, "valid": true } ], "status": 0 } } } } } } } }, "description": "Adds a Calculation (`CompensationRecordSetCalculation`) for the specified Compensation Record Set.", "tags": [ "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationRequest", "properties": { "data": { "type": "object", "properties": { "label": { "type": "string" }, "compensationRecordSetId": { "type": "integer" } } }, "operationType": { "type": "string" } } }, "examples": { "addCalculationRequestExample": { "value": { "data": { "label": "SC_records", "compensationRecordSetId": 1 }, "operationType": "add" } } } } } } } }, "/fetch/CORSC": { "post": { "summary": "List Calculations", "operationId": "post-fetch-CORSC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecordSetCalculation" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listCalculationsResponseExample": { "value": { "response": { "node": "node1", "startRow": 0, "data": [ { "version": 609, "typedId": "3.CORSC", "label": "Sales Compensations", "calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]", "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "dtoFilter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "sourceId", "operator": "equals", "value": "CO-156" }, { "fieldName": "sourceId", "operator": "equals", "value": "CO-155" }, { "fieldName": "sourceId", "operator": "equals", "value": "CO-154" } ], "operator": "or" }, "calculationType": "RECORD", "calculationConfig": { "formulaName": "SC_Compensation", "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "createDate": "2022-06-09T08:21:13", "createdBy": 290, "lastUpdateDate": "2022-06-24T09:49:31", "lastUpdateBy": 290, "status": "READY", "calculationStartDate": "2022-06-24T09:17:46", "calculationDate": "2022-06-24T09:49:31", "isDefault": true, "incremental": false, "incCalculationDate": "2022-06-24T09:17:46", "shouldSubmit": false, "valid": true } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Retrieves Calculation (`CompensationRecordSetCalculation`) objects. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listCalculationsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "equals", "value": "READY" } ] } } } } } } } } }, "/calculationrecord.savecalc": { "post": { "summary": "Save Calculation", "operationId": "post-calculationrecord.savecalc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "saveCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecordSetCalculation" } }, "status": { "type": "integer" } } } } }, "examples": { "saveCalculationResponseExample": { "value": { "response": { "node": "node1", "data": [ { "version": 617, "typedId": "3.CORSC", "targetDate": null, "label": "Sales Compensations", "locale": null, "calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]", "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "compensationRecordSet": { "version": 0, "typedId": "1.CORS", "targetDate": null, "label": "Sales Compensations", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "userGroupEdit": null, "userGroupViewDetails": null, "updatedBy": 119, "updateDate": "2022-05-05", "recordSetId": 1, "createDate": "2022-05-05T11:36:03", "createdBy": 119, "lastUpdateDate": "2022-05-05T11:36:03", "lastUpdateBy": 119, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 1 }, "dtoFilter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "sourceId", "operator": "equals", "value": "CO-157" } ], "operator": "and" }, "sortBy": null, "calculationType": "RECORD", "adhocCalculation": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": "SC_Compensation", "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [], "targetFields": null }, "createDate": "2022-06-09T08:21:13", "createdBy": 290, "lastUpdateDate": "2022-06-24T10:59:56", "lastUpdateBy": 1687, "status": "READY", "calculationStartDate": "2022-06-24T10:26:20", "calculationDate": "2022-06-24T10:44:59", "isDefault": true, "incremental": false, "incCalculationDate": "2022-06-24T10:44:59", "shouldSubmit": false, "valid": true } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Updates Calculation details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "saveCalculationRequest", "properties": { "data": { "$ref": "#/components/schemas/CompensationRecordSetCalculation" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "oldValues": { "type": "object", "nullable": true } } }, "examples": { "saveCalculationRequestExample": { "value": { "data": { "version": 617, "typedId": "3.CORSC", "label": "Sales Compensations", "calculationMessages": "[\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\",\"Compensation calculated successfully\"]", "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "dtoFilter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "sourceId", "operator": "equals", "value": "CO-157" } ], "operator": "and" }, "calculationType": "RECORD", "calculationConfig": { "formulaName": "SC_Compensation", "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "createDate": "2022-06-09T08:21:13", "createdBy": 290, "lastUpdateDate": "2022-06-24T10:44:59", "lastUpdateBy": 290, "status": "READY", "calculationStartDate": "2022-06-24T10:26:20", "calculationDate": "2022-06-24T10:44:59", "isDefault": true, "incremental": false, "incCalculationDate": "2022-06-24T10:26:20", "shouldSubmit": false, "valid": true }, "operationType": "update", "textMatchStyle": "exact", "oldValues": null } } } } } } } }, "/calculationrecord.calculateset": { "post": { "summary": "Run a Calculation", "operationId": "post-calculationrecord.calculateset", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "runCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "runCalculationResponseExample": { "value": { "response": { "node": "node1", "data": [ { "version": 0, "typedId": "8613396.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "COMPENSATION_RECORD", "targetObject": "8.CORSC", "jobName": "SC_records2", "concurrencyKey": "8.CORSC", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "CORSC", "uuid": "GQ5mW", "calculableObjectTypedId": "8.CORSC", "queueName": null, "runNumber": 0, "partitionName": "templates-qa", "partitionUUID": "7TsPKxW2jL", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2022-06-24T11:25:02", "createdBy": 1687, "lastUpdateDate": "2022-06-24T11:25:02", "lastUpdateBy": 1687, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 8613396 } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Starts the calculation job (`JST`) of the calculation set. Returns the `JobStatusTracker` object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "runCalculationRequest", "properties": { "data": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "label": { "type": "string" }, "compensationRecordSetId": { "type": "integer" }, "compensationRecordSetLabel": { "type": "string" }, "calculationConfig": { "type": "object", "properties": { "feederInputParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "inputParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "mappingParams": { "type": "array", "items": { "type": "object", "properties": {} } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string" }, "isDefault": { "type": "boolean" }, "incremental": { "type": "boolean" }, "shouldSubmit": { "type": "boolean" }, "valid": { "type": "boolean" } } } } }, "examples": { "runCalculationRequestExample": { "value": { "data": { "version": 7, "typedId": "8.CORSC", "label": "SC_records2", "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "calculationConfig": { "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "createDate": "2022-06-24T09:12:39", "createdBy": 1687, "lastUpdateDate": "2022-06-24T11:23:35", "lastUpdateBy": 1687, "status": "CANCELLED", "isDefault": false, "incremental": true, "shouldSubmit": false, "valid": true } } } } } } } } }, "/clicmanager.deleteCompensationCalculation": { "post": { "summary": "Delete a Calculation", "tags": [ "Sales Compensations" ], "responses": { "200": { "description": "OK - returns the deleted object's data.", "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecordSetCalculation" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteCalculationResponseExample": { "value": { "response": { "node": "node1", "data": [ { "version": 10, "typedId": "8.CORSC", "targetDate": null, "label": "SC_records2", "locale": null, "calculationMessages": null, "compensationRecordSetId": 1, "compensationRecordSetLabel": "Sales Compensations", "compensationRecordSet": null, "dtoFilter": null, "sortBy": null, "calculationType": null, "adhocCalculation": null, "calculationConfig": { "skuField": null, "targetDateField": null, "simulationSet": null, "formulaName": null, "targetDate": null, "feederFormulaName": null, "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [], "targetFields": null }, "createDate": "2022-06-24T09:12:39", "createdBy": 1687, "lastUpdateDate": "2022-06-24T11:30:31", "lastUpdateBy": 1687, "status": "CANCELLED", "calculationStartDate": null, "calculationDate": null, "isDefault": false, "incremental": true, "incCalculationDate": null, "shouldSubmit": false, "valid": true } ], "status": 0 } } } } } } } }, "operationId": "post-delete-clicmanager.deleteCompensationCalculation", "description": "Deletes the specified *CompensationRecordSetCalculation* object. Returns the deleted object in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "example": "123.CORSC" } } } }, "required": [ "data" ] }, "examples": { "deleteCalculationRequestExample": { "value": { "data": { "typedId": "8.CORSC" } } } } } } } }, "parameters": [] }, "/compensationrecord.save": { "post": { "summary": "Save a Compensation Record", "tags": [ "Sales Compensations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "saveCompensationRecordResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecord" } }, "status": { "type": "integer" } } } } } } } } }, "operationId": "post-compensationrecord.save", "description": "Updates a Compensation Record.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "saveCompensationRecordRequest", "properties": { "data": { "type": "object", "properties": { "compensationRecord": { "$ref": "#/components/schemas/CompensationRecord" } } } } }, "examples": {} } } } } }, "/compensationrecord.fetch/{compensationRecordSetId}": { "post": { "summary": "List Compensation Records", "operationId": "post-compensationrecord.fetch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCompensationRecordsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecord" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": {} } } } }, "tags": [ "Sales Compensations" ], "description": "Retrieves all Compensation Records based on filter settings.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "ListCompensationRecordsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "anyOf": [ { "type": "object", "nullable": true } ] }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listCompensationRecordsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sourceId", "operator": "equals", "value": "CO-158" } ] } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "compensationRecordSetId", "in": "path", "required": true, "description": "ID of the CompensationRecordSet into which this Compensation Record belongs. By default it belongs to \"Default\" CompensationRecordSet, but you can change it when you create the Compensation Record. This can be useful if you create different \"kinds\" of Compensation Records which will be used to calculate different results at different times." } ] }, "/compensationrecord.update": { "post": { "summary": "Update a Compensation Record", "tags": [ "Sales Compensations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateCompensationRecordResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationRecord" } }, "status": { "type": "integer" } } } } } } } } }, "operationId": "post-compensationrecord.update", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCompensationRecordRequest", "properties": { "data": { "$ref": "#/components/schemas/CompensationRecord" } } }, "examples": {} } } }, "description": "Updates a CompensationRecord object." } }, "/compensationrecord.revoke/{typedId}": { "post": { "summary": "Revoke a Compensation Record", "tags": [ "Sales Compensations" ], "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "operationId": "post-compensationrecord.revoke", "description": "The Revoke action is available only for approved records. This action is useful when the Compensation Record was approved in Pricefx, integration did not happen yet and there is nothing to reverse in ERP. When this action is used, the record changes its status to **Revoked**.
\nThe *Administer Compensation Records* user role is needed to perform the Revoke action." }, "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Compensation Record you want to revoke." } ] }, "/fetch/COAR": { "post": { "summary": "List Accrual Records", "operationId": "post-fetch-COAR", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listAccrualRecordsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationAccrualRecord" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listAccrualRecordsResponseExample": { "value": { "response": { "node": "node1", "startRow": 0, "data": [ { "version": 0, "typedId": "3692734.COAR", "compensationRecordUN": "COR-100", "type": "Sales Compensation", "name": "2022-Q4 [SC] Single Target Amount-SC-002 - COAR Summary", "startDate": "2022-10-01", "endDate": "2022-12-31", "payoutDate": "2023-01-02", "createDate": "2022-06-22T09:58:52", "createdBy": 290, "lastUpdateDate": "2022-06-22T09:58:52", "lastUpdateBy": 290, "attribute1": "SC-002", "attribute2": "", "attribute3": "", "attribute4": "", "attribute5": "", "attribute6": 0, "attribute7": "", "attribute8": "", "attribute9": "", "attribute10": "", "attribute11": 0, "attribute12": "", "attribute13": "", "attribute14": "", "attribute15": "", "attribute16": 0, "attribute17": "", "attribute18": "", "attribute19": "Summary", "attribute20": "0.75", "attribute21": "CO-26", "compensationType": "SC_SingleTargetAmount" } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Retrieves Accrual Records. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listAccrualRecordsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listAccrualRecordsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "compensationRecordUN", "operator": "equals", "value": "COR-100" } ] } } } } } } } } }, "/importfile/SX/{SXCategory}/{slotId}": { "parameters": [ { "schema": { "type": "string" }, "name": "SXCategory", "in": "path", "required": true, "description": "The Seller Extension category (the `Name` from the *Seller Master Extension* table)." }, { "schema": { "type": "string" }, "name": "slotId", "in": "path", "required": true, "description": "The ID that is returned by the **/uploadmanager.newuploadslot** (Create an Upload Slot) endpoint." } ], "post": { "summary": "Import a File", "operationId": "post-importfile-SX-SXCategory-slotId", "tags": [ "Seller Extensions" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "truncate", "description": "Set to *false* to add records from the file as new lines to the existing data. Set to *true* to delete all previous records in the SX table. " } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "title": "importSXFileRequest", "properties": { "fileName": { "type": "string", "format": "binary" } } } } } }, "description": "Uploads a CSV or XLSX file to the Seller Extensions table.
\nDelete the upload slot using the **/uploadmanager.deleteslot/{slot_id}** (Delete an Upload Slot) endpoint after the file has been uploaded.", "responses": { "202": { "description": "Accepted" } } } }, "/kvservice.createtable/{tableName}": { "post": { "summary": "Create a KV Table", "operationId": "post-kvservice.createtable", "tags": [ "Key-Value Store" ], "description": "Creates a table in the Key-Value Database Storage.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "createKVTableRequest", "properties": { "data": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "columnType": { "type": "string", "enum": [ "UUID", "TEXT", "INT", "TIMESTAMP", "DECIMAL", "DATE" ] }, "columnName": { "type": "string", "description": "A unique name of the column. Only lower case letters, numbers and underscores are allowed. Do not use special characters." }, "isPrimaryKey": { "type": "boolean", "description": "Sets the column as a primary key. A primary key uniquely identifies a column, so it can be used for a look up. At least one column must be set as a primary key." }, "isIndexed": { "type": "boolean", "description": "Additional non-Primary Key columns can be added for further filtering (you cannot filter on “payload”). If also fast lookup on these secondary columns is required they should be indexed. See also [Performance Considerations](https://knowledge.pricefx.com/configuration-engineer-knowledge-base/reference/groovy-api-functions/key-value-database-storage#Performance-Considerations)." } } } } } } } }, "examples": { "createKVTableRequestExample": { "value": { "data": { "keys": [ { "columnType": "TEXT", "columnName": "sku", "isPrimaryKey": true }, { "columnType": "TEXT", "columnName": "customer", "isPrimaryKey": true }, { "columnType": "INT", "columnName": "record", "isIndexed": true } ] } } } } } }, "description": "The sample request creates a table with four columns: sku, customer, record and payload (TEXT).
\nNote: The “payload” column is always added automatically and must not be present in the creation definition." }, "responses": { "200": { "$ref": "#/components/responses/generalResponse" } } }, "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want create. Only lower case letters, numbers and underscores are allowed. Do not use special characters." } ] }, "/kvservice.droptable/{tableName}": { "post": { "summary": "Drop a KV Table", "operationId": "post-kvservice.droptable", "tags": [ "Key-Value Store" ], "description": "Drops (deletes) a table in the Key-Value Database Storage.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Table dropped." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want drop. Only lower case letters, numbers and underscores are allowed. Do not use special characters." } ] }, "/kvservice.listtables": { "get": { "summary": "List KV Tables", "tags": [ "Key-Value Store" ], "operationId": "get-kvservice.listtables", "description": "Retrieves a list of tables in the Key-Value Database.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "title": "listKVTablesResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "csrfToken": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": {} } }, "status": { "type": "integer" } } } } }, "examples": { "listTablesResponseExample": { "value": { "response": { "node": "node", "csrfToken": "token", "data": [ [ "px_cablecuts", "conditionssix", "prices" ] ], "status": 0 } } } } } } } } } }, "/kvservice.loaddata/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want upload data to." } ], "post": { "summary": "Insert Bulk KV Data", "operationId": "post-kvservice.loaddata-tableName", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Key-Value Store" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "InsertBulkKVDataRequest", "properties": { "data": { "type": "object", "properties": { "header": { "type": "array", "items": { "type": "string" } }, "data": { "type": "array", "items": { "type": "array", "items": {} } } } } } }, "examples": { "insertBulkKVDataRequestExample": { "value": { "data": { "header": [ "sku", "customer", "record", "payload" ], "data": [ [ "A1", "83-3126689", 1, "{ ... JSON ... }" ], [ "A1", "45-0245039", 1, "{ ... JSON ... }" ], [ "A2", "02-0995855", 1, "{ ... JSON ... }" ] ] } } } } } } }, "description": "Inserts bulk data to the Key-Value Store.
\nExisting Primary Key combos are overwritten automatically. This is the only command where you explicitly have to specify the automatic “payload” column. While technically you could put any text into that column, other endpoints and Groovy perform JSON conversions (e.g. return a proper map) when you perform key lookups. So inserting a valid JSON into payload is highly recommended!" } }, "/kvservice.fetch/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want to search the pattern for." } ], "post": { "summary": "Search a KV Table", "operationId": "post-kvservice.fetch-tableName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "title": "searchKVTableResponse", "items": { "type": "object", "properties": { "payload": { "type": "string" }, "record": { "type": "integer" }, "sku": { "type": "string" }, "customer": { "type": "string" } } } }, "examples": { "searchKVTableResponseExample": { "value": [ { "payload": "{}", "record": 1, "sku": "A1", "customer": "B2" }, { "payload": "{}", "record": 1, "sku": "A1", "customer": "83-3126689" }, { "payload": "{}", "record": 1, "sku": "A1", "customer": "45-0245039" } ] } } } } } }, "tags": [ "Key-Value Store" ], "description": "Returns records that match the search criteria.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "searchKVTableRequest", "properties": { "data": { "type": "object", "properties": { "sku": { "type": "string" } } } } }, "examples": { "searchKVTableRequestExample": { "value": { "data": { "sku": "SKUABCDE12345" } } } } } }, "description": "" } } }, "/kvservice.putkey/{tableName}": { "post": { "summary": "Upsert a Key", "operationId": "post-kvservice.putkey", "responses": { "200": { "description": "OK. Returns `\"data\" : null` when successfully inserted/updated.", "content": { "application/json": { "schema": { "type": "object", "title": "upsertKVKeyResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "csrfToken": { "type": "string" }, "data": { "type": "object", "nullable": true }, "status": { "type": "integer" } } } } } } } } }, "description": "Inserts a new key to the table or updates the existing one.", "tags": [ "Key-Value Store" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "upsertKVKeyRequest", "properties": { "data": { "type": "object", "properties": { "keys": { "type": "object", "properties": { "sku": { "type": "string" }, "customer": { "type": "string" } } }, "payload": { "type": "string" } } } } }, "examples": { "upsertKVKeyRequestExample": { "value": { "data": { "keys": { "sku": "sku_123456", "customer": "cus_123456" }, "payload": "payload" } } } } } }, "description": "" } }, "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want to upsert the key into." } ] }, "/kvservice.describetable/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want to retrieve information about." } ], "get": { "summary": "Get a Table Info", "operationId": "get-kvservice.describetable-tableName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getKVTableInfoResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "primary_keys": { "type": "array", "items": { "type": "string" } }, "indexes": { "type": "array", "items": { "type": "object" } }, "columns": { "type": "array", "items": { "type": "string" } } } } }, "status": { "type": "integer" } } } } }, "examples": { "getKVTableInfoResponseExample": { "value": { "response": { "node": "node", "data": [ { "primary_keys": [ "sku", "customer" ], "indexes": [], "columns": [ "sku TEXT", "customer TEXT", "payload TEXT", "record INT" ] } ], "status": 0 } } } } } } } }, "description": "Retrieves primary keys, column names, column types, and indexes of the specified table.", "tags": [ "Key-Value Store" ] } }, "/kvservice.fetchkey/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "A name of the table you want to retrieve the \"payload\" from." } ], "post": { "summary": "Get a Key", "operationId": "post-kvservice.fetchkey-tableName", "responses": { "200": { "description": "OK. The \"payload\" is returned." } }, "tags": [ "Key-Value Store" ], "description": "Retrieves the `payload` from the table with the specified key. The request must contain key/value pairs for **all** primary keys as defined in table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getKVKeyRequest", "properties": { "data": { "type": "object", "properties": { "keys": { "type": "object", "properties": { "sku": { "type": "string" }, "customer": { "type": "string" } } } } } } }, "examples": { "getKVKeyRequestExample": { "value": { "data": { "keys": { "sku": "A1", "customer": "B2" } } } } } } } } } }, "/kvservice.count/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "The table to count keys from." } ], "get": { "summary": "Count Keys", "tags": [ "Key-Value Store" ], "responses": { "200": { "description": "OK - the number of keys." } }, "operationId": "get-kvservice.count-tableName", "description": "Retrieves the number of keys in the specified table." } }, "/kvservice.truncate/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true, "description": "The table you want to remove the keys from." } ], "get": { "summary": "Truncate a Table", "tags": [ "Key-Value Store" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "truncateKVTableResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "status": { "type": "integer" } } } } }, "examples": {} } } } }, "operationId": "get-kvservice.truncate-tableName", "description": "Truncates the table; removes all key values from the table. Table structure (primary keys, columns, indexes) remains." } }, "/kvservice.removekey/{tableName}": { "parameters": [ { "schema": { "type": "string" }, "name": "tableName", "in": "path", "required": true } ], "post": { "summary": "Delete a Key", "operationId": "post-kvservice.removekey-tableName", "responses": { "200": { "description": "OK. Returns `null` when successfully deleted." } }, "tags": [ "Key-Value Store" ], "description": "Removes a value based on the primary key match – the request must contain all table's primary keys (see the request example).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteKVKeyRequest", "properties": { "data": { "type": "object", "properties": { "keys": { "type": "object", "properties": { "sku": { "type": "string" }, "customer": { "type": "string" } } } } } } }, "examples": { "deleteKeyRequestExample": { "value": { "data": { "keys": { "sku": "sku", "customer": "customer" } } } } } } } } } }, "/add/CLT": { "post": { "summary": "Add a Claim Type", "operationId": "post-add-CLT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addClaimTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimType" } }, "status": { "type": "integer" } } } } }, "examples": { "addClaimTypeResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "12.CLT", "uniqueName": "CLT01", "label": "Claim Type 01", "formulaName": "claimCalculation", "allocationFormulaName": "claimAllocation", "validationStateElementName": "validationState", "sheetName": "DATA", "configuration": null, "createDate": "2022-10-07T09:13:41", "createdBy": 2147490187, "lastUpdateDate": "2022-10-07T09:13:41", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } }, "tags": [ "Claim Types" ], "description": "Adds a Claim Type to the Claim Types table.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addClaimTypeRequest", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string" }, "label": { "type": "string" }, "formulaName": { "type": "string" }, "sheetName": { "type": "string" }, "validationStateElementName": { "type": "string" }, "allocationFormulaName": { "type": "string" } }, "required": [ "uniqueName", "label", "formulaName" ] }, "operation": { "type": "string" } }, "required": [ "operation" ] }, "examples": { "addClaimTypeRequestExample": { "value": { "data": { "uniqueName": "CLT01", "label": "Claim Type 01", "formulaName": "claimCalculation", "sheetName": "DATA", "validationStateElementName": "validationState", "allocationFormulaName": "claimAllocation" }, "operation": "add" } } } } } } } }, "/update/CLT": { "post": { "summary": "Update a Claim Type", "operationId": "post-update-CLT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateClaimTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "formulaName": { "type": "string" }, "allocationFormulaName": { "type": "string" }, "validationStateElementName": { "type": "string" }, "sheetName": { "type": "string" }, "configuration": { "type": "object", "properties": { "columns": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fieldFormatType": { "type": "string", "nullable": true }, "canEdit": { "type": "boolean" } } } } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "updateClaimTypeResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 1, "typedId": "12.CLT", "uniqueName": "CLT01", "label": "Claim Type 01", "formulaName": "claimCalculation", "allocationFormulaName": "claimAllocation", "validationStateElementName": "validationState", "sheetName": "DATA", "configuration": { "columns": { "sku": { "name": null, "fieldFormatType": null, "canEdit": true } } }, "createDate": "2022-10-07T09:13:41", "createdBy": 2147490187, "lastUpdateDate": "2022-10-07T09:50:33", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } }, "tags": [ "Claim Types" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateClaimTypeRequest", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "configuration": { "type": "object", "properties": { "columns": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "fieldFormatType": { "type": "string", "nullable": true }, "canEdit": { "type": "boolean" } } } } } } } }, "required": [ "typedId", "configuration" ] }, "oldValues": { "type": "object", "required": [ "version", "typedId" ], "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "formulaName": { "type": "string" }, "allocationFormulaName": { "type": "string" }, "validationStateElementName": { "type": "string" }, "sheetName": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "oldValues", "operationType" ] }, "examples": { "updateClaimTypeRequestExample": { "value": { "data": { "typedId": "12.CLT", "configuration": { "columns": { "sku": { "name": null, "fieldFormatType": null, "canEdit": true } } } }, "oldValues": { "version": 0, "typedId": "12.CLT", "uniqueName": "CLT01", "label": "Claim Type 01", "formulaName": "claimCalculation", "allocationFormulaName": "claimAllocation", "validationStateElementName": "validationState", "sheetName": "DATA", "createDate": "2022-10-07T09:13:41", "createdBy": 2147490187, "lastUpdateDate": "2022-10-07T09:13:41", "lastUpdateBy": 2147490187 }, "operationType": "update", "textMatchStyle": "exact" } } } } } }, "description": "Updates a Claim Type." } }, "/delete/CLT": { "post": { "summary": "Delete a Claim Type", "operationId": "post-delete-CLT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteClaimTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimType" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteClaimTypeResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-57c6448bd-62zqf", "data": [ { "version": 0, "typedId": "13.CLT", "uniqueName": "Copy of CLT01", "label": "Copy of Claim Type 01", "formulaName": "claimCalculation", "allocationFormulaName": "claimAllocation", "validationStateElementName": "validationState", "sheetName": "DATA", "configuration": { "columns": { "sku": { "name": null, "fieldFormatType": null, "canEdit": true } } }, "createDate": "2022-10-07T10:09:30", "createdBy": 2147490187, "lastUpdateDate": "2022-10-07T10:09:46", "lastUpdateBy": 2147490187 } ], "status": 0 } } } } } } } }, "tags": [ "Claim Types" ], "description": "Deletes a Claim Type. Specify the `typedId` of the Claim Type you want to delete in the request (see the request example).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteClaimTypeRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "deleteClaimTypeRequestExample": { "value": { "data": { "typedId": "13.CLT" } } } } } } } } }, "/fetch/CLT": { "post": { "summary": "List Claim Types", "operationId": "post-fetch-CLT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listClaimTypesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "formulaName": { "type": "string" }, "allocationFormulaName": { "type": "string" }, "validationStateElementName": { "type": "string" }, "sheetName": { "type": "string" }, "configuration": { "type": "object", "properties": { "columns": { "type": "object", "properties": { "sku": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "quantity": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute1": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute2": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute3": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute4": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute5": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute6": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "attribute7": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "totalAmount": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } }, "endCustomerId": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string" }, "canEdit": { "type": "boolean" } } } } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listClaimTypesResponseExample": { "value": { "response": { "node": "node", "startRow": 0, "data": [ { "version": 3, "typedId": "6.CLT", "uniqueName": "claimType", "label": "Claim Type", "formulaName": "claimCalculation", "allocationFormulaName": "claimAllocation", "validationStateElementName": "validationState", "sheetName": "DATA", "configuration": { "columns": { "sku": { "name": "ProductID", "fieldFormatType": "TEXT", "canEdit": false }, "quantity": { "name": "ClaimQuantity", "fieldFormatType": "INTEGER", "canEdit": false }, "attribute1": { "name": "QuoteID", "fieldFormatType": "TEXT", "canEdit": true }, "attribute2": { "name": "QuoteValidFrom", "fieldFormatType": "DATE", "canEdit": false }, "attribute3": { "name": "QuoteValidTo", "fieldFormatType": "DATE", "canEdit": false }, "attribute4": { "name": "QuoteDiscountPerItemPercent", "fieldFormatType": "PERCENT", "canEdit": true }, "attribute5": { "name": "InvoicePricePerItem", "fieldFormatType": "MONEY", "canEdit": false }, "attribute6": { "name": "NetPricePerItem", "fieldFormatType": "MONEY", "canEdit": false }, "attribute7": { "name": "DiscountPerItemAmount", "fieldFormatType": "MONEY", "canEdit": false }, "totalAmount": { "name": "TotalClaimAmount", "fieldFormatType": "MONEY", "canEdit": false }, "endCustomerId": { "name": "EndCustomerID", "fieldFormatType": "TEXT", "canEdit": false } } }, "createDate": "2020-09-07T08:20:55", "createdBy": 2147483667, "lastUpdateDate": "2020-09-07T08:26:26", "lastUpdateBy": 2147483667 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Claim Types" ], "description": "Retrieves all Claim Types, or Claim Types that match a filter.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listClaimTypesRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listClaimTypesRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "uniqueName", "operator": "iEquals", "value": "claimType" } ] } } } } } }, "description": "The example of the request body contains the filter. The call returns Claim Types whose `name` equals to \"claimType\"." } } }, "/add/CL": { "post": { "summary": "Add a Claim", "operationId": "post-add-CL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addClaimResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Claim" } }, "status": { "type": "integer" } } } } }, "examples": { "addClaimResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 1, "typedId": "24.CL", "targetDate": null, "label": "Claim01", "locale": null, "calculationMessages": null, "uniqueName": "CL-24", "customerId": null, "customerName": null, "claimType": "claimType", "fileHandle": null, "fileName": null, "externalRef": null, "claimRecord": null, "workflowStatus": "DRAFT", "progress": null, "createdByName": "ondrej.tesar", "submittedByName": null, "approvedByName": null, "deniedByName": null, "lastUpdateByName": "ondrej.tesar", "submitDate": null, "claimStatus": "DRAFT", "sourceContractUniqueName": null, "sourceQuoteUniqueName": null, "approvalRequiredEmailAttachments": null, "createDate": "2022-10-10T08:21:11", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T08:21:11", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 24 } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Adds a Claim without any data and items. Use the `update/CL` (Update a Claim) to add the data (e.g., uploaded file) to the Claim.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addClaimRequest", "properties": { "data": { "type": "object", "required": [ "label", "claimType" ], "properties": { "label": { "type": "string" }, "claimType": { "type": "string" } } }, "operation": { "type": "string" } }, "required": [ "data", "operation" ] }, "examples": { "addClaimRequestExample": { "value": { "data": { "label": "Claim01", "claimType": "claimType" }, "operation": "add" } } } } } } } }, "/fetch/CL": { "post": { "summary": "List Claims", "operationId": "post-fetch-CL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listClaimsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "$ref": "#/components/schemas/Claim" } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "listClaimsResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-7f9df79f47-5pp4l", "data": [ { "version": 28, "typedId": "24.CL", "targetDate": "2022-10-09", "label": "Claim01", "uniqueName": "CL-24", "customerId": "Distributor1", "customerName": "Distributor 1", "claimType": "claimType", "fileHandle": "1140.BD@0", "fileName": "DataExport-1664881422978_CLAIMS.xlsx", "workflowStatus": "DRAFT", "progress": "16/16", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "claimStatus": "DRAFT", "createDate": "2022-10-10T08:21:11", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T08:44:30", "lastUpdateBy": 2147490187, "status": "READY", "calculationStartDate": "2022-10-10T08:44:53", "calculationDate": "2022-10-10T08:44:55", "id": 24 } ], "endRow": 1 } } } } } } } }, "tags": [ "Claims" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "listClaimsRequest", "type": "object", "properties": { "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "oldValues": {}, "operationType": { "type": "string", "minLength": 1 }, "startRow": { "type": "number", "description": "The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results." }, "textMatchStyle": { "type": "string", "minLength": 1 } } }, "examples": { "listClaimsRequestExample": { "value": { "operationType": "fetch", "textMatchStyle": "exact", "data": { "fieldName": "uniqueName", "operator": "equals", "value": "CL-24", "_constructor": "AdvancedCriteria" }, "oldValues": null } } } } }, "description": "" }, "description": "Retrieves a list of Claims. A filter can be applied (for example, to retrieve a particular Claim with the specified name).\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n CLAIM_FETCH | Investigate for Support (`SUPPORT`), Administer Plasma (`PLASMA`), Manage Claims (`CLM_CLAIMMANAGER`), Use Claims (`CLM_CLAIM`)" } }, "/update/CL": { "post": { "summary": "Update a Claim", "operationId": "post-update-CL", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateClaimResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Claim" } }, "status": { "type": "integer" } } } } }, "examples": { "updateClaimResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7b54f8ddf6-hwfnn", "data": [ { "version": 9, "typedId": "24.CL", "targetDate": "2022-10-09", "label": "Claim01", "locale": null, "calculationMessages": null, "uniqueName": "CL-24", "customerId": "Distributor1", "customerName": "Distributor 1", "claimType": "claimType", "fileHandle": "1140.BD@0", "fileName": "DataExport-1664881422978_CLAIMS.xlsx", "externalRef": null, "claimRecord": null, "workflowStatus": "DRAFT", "progress": null, "createdByName": "ondrej.tesar", "submittedByName": null, "approvedByName": null, "deniedByName": null, "lastUpdateByName": "ondrej.tesar", "submitDate": null, "claimStatus": "DRAFT", "sourceContractUniqueName": null, "sourceQuoteUniqueName": null, "approvalRequiredEmailAttachments": null, "createDate": "2022-10-10T08:21:11", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T08:44:30", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 24 } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Updates the Claim object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateClaimRequest", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "version": { "type": "integer" }, "fileHandle": { "type": "string" }, "fileName": { "type": "string" } }, "required": [ "typedId", "version" ] } }, "required": [ "operationType" ] }, "examples": { "updateClaimRequestExample": { "value": { "operationType": "update", "textMatchStyle": "exact", "data": { "typedId": "24.CL", "version": 7, "fileHandle": "1140.BD@0", "fileName": "DataExport-1664881422978_CLAIMS.xlsx" } } } } } }, "description": "" } } }, "/claimmanager.calculate/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "24.CL" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the claim whose items you want to calculate." } ], "post": { "summary": "Calculate a Claim", "operationId": "post-claimmanager.calculate-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "calculateClaimResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "calculateClaimResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "2148038570.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "CLAIM", "targetObject": "24.CL", "jobName": "Claim01", "concurrencyKey": "24.CL", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "CL", "uuid": "bZsvn", "calculableObjectTypedId": "24.CL", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3734326638", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2022-10-10T08:44:30", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T08:44:30", "lastUpdateBy": 2147490187, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148038570 } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Calculates a Claim (runs the validation logic on all items. Creates a calculation job (JST). It does not read the data from the uploaded Excel file again but works with the (potentially edited) data that are already loaded in the system.

\nYou can also send items within the request body (no Excel file needed) – see the request example (calculateClaimRequestExample) for the request body structure.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "calculateClaimRequest", "properties": { "data": { "type": "object", "properties": { "columnNames": { "type": "array", "description": "A list of column names.", "items": { "type": "string" } }, "data": { "type": "array", "description": "Key-value pairs, where the key is the column name and value is the actual item data.", "items": { "type": "object" } } } } } }, "examples": { "calculateClaimRequestExample": { "value": { "data": { "columnNames": [ "ProductID", "EndCustomerID", "ClaimQuantity", "TotalClaimAmount", "QuoteID", "QuoteValidFrom", "QuoteValidTo", "QuoteDiscountPerItemPercent", "InvoicePricePerItem", "NetPricePerItem", "DiscountPerItemAmount" ], "data": [ { "ProductID": "CLPRD-3", "EndCustomerID": "EndCustomer1", "ClaimQuantity": "2", "TotalClaimAmount": "23", "QuoteID": "P-2147483919", "QuoteValidFrom": "2022-10-13", "QuoteValidTo": "2023-04-25", "QuoteDiscountPerItemPercent": "5", "InvoicePricePerItem": "100", "NetPricePerItem": "95", "DiscountPerItemAmount": "5" } ] } } } } } } } } }, "/claimmanager.cancel/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "24.CL" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the claim whose item calculation you want to cancel." } ], "post": { "summary": "Cancel a Calculation", "operationId": "post-claimmanager.cancel-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "cancelClaimCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Claims" ], "description": "Cancels the Claim calculation job.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "cancelClaimCalculationRequest", "properties": {} } } } } } }, "/claimmanager.fetchitems/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "24.CL" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "List Items", "operationId": "post-claimmanager-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listClaimItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimLineItem" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listItemsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7d4f6fc499-cxpsb", "startRow": 0, "data": [ { "version": 1, "typedId": "2650.CLLI", "sku": "CLPRD-1", "endCustomerId": "EndCustomer1", "quantity": 2, "totalAmount": 10, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:54", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:11", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.05", "attribute5": "100", "attribute6": "95", "attribute7": "5" }, { "version": 2, "typedId": "2651.CLLI", "sku": "CLPRD-2", "endCustomerId": "EndCustomer1", "quantity": 6, "totalAmount": 60, "validationState": "VALIDATED", "calculationStatus": 4, "createDate": "2022-10-10T08:44:54", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:11", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.5", "attribute5": "20", "attribute6": "19", "attribute7": "10" }, { "version": 1, "typedId": "2652.CLLI", "sku": "CLPRD-3", "endCustomerId": "EndCustomer1", "quantity": 6, "totalAmount": 1.2, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:54", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:11", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.01", "attribute5": "20", "attribute6": "19", "attribute7": "0.2" }, { "version": 1, "typedId": "2653.CLLI", "sku": "CLPRD-4", "endCustomerId": "EndCustomer1", "quantity": 600000, "totalAmount": 1920000, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:11", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.16", "attribute5": "20", "attribute6": "19", "attribute7": "3.2" }, { "version": 1, "typedId": "2654.CLLI", "sku": "CLPRD-5", "endCustomerId": "EndCustomer1", "quantity": 950, "totalAmount": 380, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:11", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.02", "attribute5": "20", "attribute6": "19", "attribute7": "0.4" }, { "version": 1, "typedId": "2655.CLLI", "sku": "CLPRD-1", "endCustomerId": "EndCustomer2", "quantity": 2, "totalAmount": 10, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.05", "attribute5": "100", "attribute6": "95", "attribute7": "5" }, { "version": 1, "typedId": "2656.CLLI", "sku": "CLPRD-2", "endCustomerId": "EndCustomer2", "quantity": 6, "totalAmount": 60, "validationState": "AUTO_REJECTED", "calculationStatus": 4, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.5", "attribute5": "20", "attribute6": "19", "attribute7": "10" }, { "version": 1, "typedId": "2657.CLLI", "sku": "CLPRD-3", "endCustomerId": "EndCustomer2", "quantity": 6, "totalAmount": 1.2, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.01", "attribute5": "20", "attribute6": "19", "attribute7": "0.2" }, { "version": 1, "typedId": "2658.CLLI", "sku": "CLPRD-4", "endCustomerId": "EndCustomer2", "quantity": 600000, "totalAmount": 600000, "validationState": "AUTO_REJECTED", "calculationStatus": 8, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.15", "attribute5": "20", "attribute6": "19", "attribute7": "1" }, { "version": 1, "typedId": "2659.CLLI", "sku": "CLPRD-5", "endCustomerId": "EndCustomer2", "quantity": 950, "totalAmount": 380, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.02", "attribute5": "20", "attribute6": "19", "attribute7": "0.4" }, { "version": 1, "typedId": "2660.CLLI", "sku": "CLPRD-1", "quantity": 2, "totalAmount": 10, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.05", "attribute5": "100", "attribute6": "95", "attribute7": "5" }, { "version": 1, "typedId": "2661.CLLI", "sku": "CLPRD-2", "quantity": 6, "totalAmount": 60, "validationState": "AUTO_REJECTED", "calculationStatus": 4, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.5", "attribute5": "20", "attribute6": "19", "attribute7": "10" }, { "version": 1, "typedId": "2662.CLLI", "sku": "CLPRD-3", "quantity": 6, "totalAmount": 1.2, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.01", "attribute5": "20", "attribute6": "19", "attribute7": "0.2" }, { "version": 1, "typedId": "2663.CLLI", "sku": "CLPRD-4", "quantity": 600000, "totalAmount": 600000, "validationState": "AUTO_REJECTED", "calculationStatus": 4, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.16", "attribute5": "20", "attribute6": "19", "attribute7": "1" }, { "version": 1, "typedId": "2664.CLLI", "sku": "CLPRD-5", "quantity": 950, "totalAmount": 380, "validationState": "AUTO_VALIDATED", "calculationStatus": 0, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.02", "attribute5": "20", "attribute6": "19", "attribute7": "0.4" }, { "version": 1, "typedId": "2665.CLLI", "sku": "CLPRD-666", "quantity": 951, "totalAmount": 379, "validationState": "AUTO_REJECTED", "calculationStatus": 22, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T10:29:12", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "1970-01-01", "attribute4": "0.02", "attribute5": "20", "attribute6": "19", "attribute7": "0.4" } ], "endRow": 16, "totalRows": 16, "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Retrieves all items of the specified Claim.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listClaimItemsRequest", "properties": {} } } } } } }, "/claimmanager.validateitems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Claim whose items you want to validate." } ], "post": { "summary": "Validate Items", "operationId": "post-claimmanager.validateitems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "validateClaimItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimLineItem" } }, "status": { "type": "integer" } } } } }, "examples": { "validateItemsResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 3, "typedId": "2658.CLLI", "sku": "CLPRD-4", "endCustomerId": "EndCustomer2", "contractUniqueName": "null", "quoteUniqueName": "null", "quantity": 600000, "totalAmount": 600000, "validationState": "VALIDATED", "calculationStatus": 8, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T11:48:46", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.15", "attribute5": "20", "attribute6": "19", "attribute7": "1", "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "validateClaimItemsRequest", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "examples": { "validateItemsRequestExample": { "value": { "data": { "items": [ "2650.CLLI", "2651.CLLI", "2652.CLLI" ] } } } } } } }, "description": "Validates specified items of the Claim." } }, "/claimmanager.rejectitems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Claim whose items you want to reject." } ], "post": { "summary": "Reject Items", "operationId": "post-claimmanager.rejectitems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "rejectClaimItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimLineItem" } }, "status": { "type": "integer" } } } } }, "examples": { "rejectItemsResponseExample": { "value": { "response": { "node": "node", "data": [ { "version": 4, "typedId": "2658.CLLI", "sku": "CLPRD-4", "endCustomerId": "EndCustomer2", "contractUniqueName": "null", "quoteUniqueName": "null", "quantity": 600000, "totalAmount": 600000, "validationState": "REJECTED", "calculationStatus": 8, "createDate": "2022-10-10T08:44:55", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T12:02:02", "lastUpdateBy": 2147490187, "attribute1": "P-2147483919", "attribute2": "2019-01-15", "attribute3": "2019-04-25", "attribute4": "0.15", "attribute5": "20", "attribute6": "19", "attribute7": "1", "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Rejects specified items of the Claim.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "rejectClaimItemsRequest", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" } } } } } }, "examples": { "rejectItemsRequestExample": { "value": { "data": { "items": [ "2650.CLLI", "2651.CLLI", "2652.CLLI" ] } } } } } } } } }, "/claimmanager.summary/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Get a Summary", "operationId": "post-claimmanager.summary-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getClaimItemsSummaryResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "total": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "number" } } }, "autoRejected": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "integer" } } }, "autoValidated": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "number" } } }, "validated": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "integer" } } }, "rejected": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "integer" } } }, "totalValidated": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "number" } } }, "totalRejected": { "type": "object", "properties": { "itemCount": { "type": "integer" }, "amount": { "type": "integer" } } } } } } } }, "status": { "type": "integer" } } } } }, "examples": { "getSummaryResponseExample": { "value": { "response": { "node": "node", "data": [ { "summary": { "total": { "itemCount": 16, "amount": 3121732.6 }, "autoRejected": { "itemCount": 4, "amount": 600499 }, "autoValidated": { "itemCount": 10, "amount": 1921173.6 }, "validated": { "itemCount": 1, "amount": 60 }, "rejected": { "itemCount": 1, "amount": 600000 }, "totalValidated": { "itemCount": 11, "amount": 1921233.6 }, "totalRejected": { "itemCount": 5, "amount": 1200499 } } } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Retrieves a summary of validated/rejected items.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getClaimItemsSummaryRequest", "properties": {} } } } } } }, "/claimmanager.clearitems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The `typedId` of the Claim whose items you want to remove." } ], "post": { "summary": "Remove Items", "operationId": "post-claimmanager.clearitems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "removeClaimItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Claims" ], "description": "Deletes all items from the Claim.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/claimmanager.submit/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "24.CL" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Claim you want to submit." } ], "post": { "summary": "Submit a Claim", "operationId": "post-claimmanager.submit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "submitClaimResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "submitClaimResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5654867dbb-mbqvg", "data": [ { "version": 0, "typedId": "2148038585.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "CLAIM_SUBMIT", "targetObject": "24.CL", "jobName": "Claim01", "concurrencyKey": "CLAIM_SUBMIT", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "CL", "uuid": "Vn82l", "calculableObjectTypedId": "24.CL", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3734326638", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2022-10-10T12:38:00", "createdBy": 2147490187, "lastUpdateDate": "2022-10-10T12:38:00", "lastUpdateBy": 2147490187, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148038585 } ], "status": 0 } } } } } } } }, "tags": [ "Claims" ], "description": "Submits the specified Claim.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "submitClaimRequest", "properties": {} } } } } } }, "/bdmanager.list/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147491329.Q" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the document you want to list attachments for." } ], "post": { "summary": "List Files", "operationId": "post-bdmanager.list-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BinaryData" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listFilesResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-cf4d85877-f5tjm", "startRow": 0, "data": [ { "version": 0, "typedId": "1145.BD", "fileName": "DataExport-1664881422978_CLAIMS.xlsx", "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "length": 4977, "createdByName": "admin", "latestUploadStatusId": 4300, "sentViaEmail": false, "createDate": "2022-10-26T11:19:01", "createdBy": 2147490696, "lastUpdateDate": "2022-10-26T11:19:01", "lastUpdateBy": 2147490696 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Attachments" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" } } } } } }, "description": "Retrieves details of the file(s) attached to the document (specified by `typedId`)." } }, "/bdmanager.download/{typedId}/{binaryDataId}": { "parameters": [ { "schema": { "type": "string", "example": "2147491329.Q" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the document you want to download the attachment from." }, { "schema": { "type": "string", "example": "1145" }, "name": "binaryDataId", "in": "path", "required": true, "description": "If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145**." } ], "post": { "summary": "Download a File", "operationId": "post-bdmanager.download-typedId-Id", "tags": [ "Attachments" ], "description": "Retrieves details of the file(s) attached to the document (specified by `typedId`).", "parameters": [ { "schema": { "type": "string", "example": "file" }, "in": "query", "name": "output", "description": "use `file` to download the binary data of the file/attachment." } ], "responses": { "200": { "description": "OK", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": {} } }, "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BinaryData" } }, "status": { "type": "integer" } } } } }, "examples": { "downloadFileResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-cf4d85877-jttn8", "data": [ { "version": 0, "typedId": "1145.BD", "embeddedOwner": null, "fileName": "DataExport-1664881422978_CLAIMS.xlsx", "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "length": 4977, "userGroupEdit": null, "userGroupViewDetails": null, "createdByName": "admin", "lastUpdateByName": null, "latestUploadStatusId": 4300, "sentViaEmail": false, "sender": null, "recipients": null, "createDate": "2022-10-26T11:19:01", "createdBy": 2147490696, "lastUpdateDate": "2022-10-26T11:19:01", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } } }, "get": { "summary": "Download a File", "operationId": "get-bdmanager.download-typedId-Id", "responses": { "200": { "description": "File metadata or content.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "embeddedOwner": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "length": { "type": "integer" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string", "nullable": true }, "latestUploadStatusId": { "type": "integer" }, "sentViaEmail": { "type": "boolean" }, "sender": { "type": "string", "nullable": true }, "recipients": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "1145.BD", "embeddedOwner": null, "fileName": "DataExport-1664881422978_CLAIMS.xlsx", "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "length": 4977, "userGroupEdit": null, "userGroupViewDetails": null, "createdByName": "admin", "lastUpdateByName": null, "latestUploadStatusId": 4300, "sentViaEmail": false, "sender": null, "recipients": null, "createDate": "2022-10-26T11:19:01", "createdBy": 2147490696, "lastUpdateDate": "2022-10-26T11:19:01", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Attachments" ], "description": "Retrieves details of the file(s) attached to the document (specified by typedId). Same behavior as POST `/bdmanager.download/{typedId}/{binaryDataId}`. If output=file is used, returns the binary file.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "output", "description": "Use `file` to download the binary content." } ] } }, "/bdmanager.checkifexists/{binaryDataId}": { "parameters": [ { "schema": { "type": "string" }, "name": "binaryDataId", "in": "path", "required": true, "description": "If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145**." } ], "post": { "summary": "Check a File", "operationId": "post-bdmanager.checkifexists-binaryDataId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "boolean" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Attachments" ], "description": "Checks whether the file with the specified `id` exists. Returns `true` within the `data` property if the file exists." } }, "/bdmanager.update/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the document whose attachment's metadata you want to update." } ], "post": { "summary": "Update a File", "operationId": "post-bdmanager.update-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "embeddedOwner": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "length": { "type": "integer" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "latestUploadStatusId": { "type": "integer" }, "sentViaEmail": { "type": "boolean" }, "sender": { "type": "string", "nullable": true }, "recipients": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "updateFileResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-54d5b6957c-vfplx", "data": [ { "version": 2, "typedId": "1146.BD", "embeddedOwner": null, "fileName": "updatedName.png", "contentType": "image/png", "length": 10278, "userGroupEdit": null, "userGroupViewDetails": null, "createdByName": "admin", "lastUpdateByName": "admin", "latestUploadStatusId": 4302, "sentViaEmail": false, "sender": null, "recipients": null, "createDate": "2022-10-26T11:37:05", "createdBy": 2147490696, "lastUpdateDate": "2022-10-26T15:09:44", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Attachments" ], "description": "Updates file's metadata (e.g., a file name).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "length": { "type": "integer" }, "createdByName": { "type": "string" }, "latestUploadStatusId": { "type": "integer" }, "sentViaEmail": { "type": "boolean" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } }, "required": [ "version", "typedId" ] } } }, "examples": { "updateFileRequestExample": { "value": { "data": { "version": 1, "typedId": "1146.BD", "fileName": "updatedName.png", "contentType": "image/png", "length": 10278, "createdByName": "admin", "latestUploadStatusId": 4302, "sentViaEmail": false, "createDate": "2022-10-26T11:37:05", "createdBy": 2147490696, "lastUpdateDate": "2022-10-26T11:37:05", "lastUpdateBy": 2147490696 } } } } } } } } }, "/bdmanager.delete/{typedId}/{binaryDataId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the document whose attachment you want to delete." }, { "schema": { "type": "string" }, "name": "binaryDataId", "in": "path", "required": true, "description": "If the `typedId` is, for example, 1145.BD then the binaryDataId is **1145**." } ], "post": { "summary": "Delete a File", "operationId": "post-bdmanager.delete-typedId", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Attachments" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteFileRequest", "properties": {} } } } }, "description": "Deletes a file attached to the specified document." } }, "/recommendations.recommend": { "post": { "summary": "List Recommendations", "operationId": "post-recommendations.recommend", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "categoryName": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "item": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "sku": { "type": "string" }, "label": { "type": "string" }, "unitOfMeasure": { "type": "string", "nullable": true }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "currency": { "type": "string" }, "formulaName": { "type": "string", "nullable": true }, "image": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "attribute1": { "type": "string", "nullable": true }, "attribute2": { "type": "string", "nullable": true }, "attribute3": { "type": "string", "nullable": true }, "attribute4": { "type": "string", "nullable": true }, "attribute5": { "description": "any type or `null`" }, "attribute6": { "type": "string", "nullable": true }, "attribute7": { "type": "integer", "nullable": true }, "attribute8": { "type": "string", "nullable": true }, "attribute9": { "type": "string", "nullable": true }, "attribute10": { "type": "string", "nullable": true }, "attribute11": { "type": "string", "nullable": true }, "attribute12": { "type": "string", "nullable": true }, "attribute13": { "type": "string", "nullable": true }, "attribute14": { "type": "string", "nullable": true }, "attribute15": { "type": "string", "nullable": true }, "attribute16": { "type": "string", "nullable": true }, "attribute17": { "type": "string", "nullable": true }, "attribute18": { "type": "string", "nullable": true }, "attribute19": { "type": "string", "nullable": true }, "attribute20": { "type": "string", "nullable": true }, "attribute21": { "type": "string", "nullable": true }, "attribute22": { "type": "string", "nullable": true }, "attribute23": { "type": "string", "nullable": true }, "attribute24": { "type": "string", "nullable": true }, "attribute25": { "type": "string", "nullable": true }, "attribute26": { "type": "string", "nullable": true }, "attribute27": { "type": "string", "nullable": true }, "attribute28": { "type": "string", "nullable": true }, "attribute29": { "type": "string", "nullable": true }, "attribute30": { "type": "string", "nullable": true } } }, "score": { "type": "integer" } } } } } } }, "status": { "type": "integer" } } } } }, "examples": { "listRecommendationsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-844d685f8b-8hn7d", "data": [ { "categoryName": "customer", "items": [] }, { "categoryName": "productHistory", "items": [ { "item": { "version": 9, "typedId": "2147484128.P", "sku": "B-0007", "label": "Lake Street Express", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "RequiredInput", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2020-05-19T09:08:57", "lastUpdateBy": 2147483667, "attribute1": null, "attribute2": null, "attribute3": "DG_03", "attribute4": "Maturity", "attribute5": null, "attribute6": "11.67", "attribute7": null, "attribute8": "2018-04-18", "attribute9": "American Pale Ale (APA)", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 3 }, { "item": { "version": 7, "typedId": "2147484127.P", "sku": "B-0006", "label": "Black Exodus", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "PFSFDCQC-1614", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": null, "attribute2": null, "attribute3": "DG_01", "attribute4": null, "attribute5": null, "attribute6": "9.38", "attribute7": null, "attribute8": "2018-04-18", "attribute9": "Oatmeal Stout", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 2 }, { "item": { "version": 8, "typedId": "2147484126.P", "sku": "B-0005", "label": "Sex and Candy", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "ConfiguratorWithManyInput", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": null, "attribute2": "A", "attribute3": "DG_03", "attribute4": null, "attribute5": null, "attribute6": "36.65", "attribute7": null, "attribute8": "2018-04-18", "attribute9": "American IPA", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 1 } ] }, { "categoryName": "productRelations", "items": [ { "item": { "version": 3, "typedId": "2147484233.P", "sku": "MB-0013", "label": "Sausage PS", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "InlineConfigurator", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Sausage", "attribute2": "C", "attribute3": "DG_03", "attribute4": "Maturity", "attribute5": "4013389366453", "attribute6": "8", "attribute7": 13000, "attribute8": "2017-01-01", "attribute9": "Pork", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 300 }, { "item": { "version": 3, "typedId": "2147484236.P", "sku": "MB-0016", "label": "Sausage LS", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "MultiTierEntry", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Sausage", "attribute2": "B", "attribute3": "DG_04", "attribute4": "Introduction", "attribute5": "4013389366456", "attribute6": "7.24", "attribute7": 16000, "attribute8": "2017-02-01", "attribute9": "Lamb", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 115 }, { "item": { "version": 3, "typedId": "2147484238.P", "sku": "MB-0018", "label": "Sausage LI", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "E2ETestsBasicLogic_withGauge", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Sausage", "attribute2": "C", "attribute3": "DG_02", "attribute4": "Maturity", "attribute5": "4013389366458", "attribute6": "17.1", "attribute7": 18000, "attribute8": "2017-02-15", "attribute9": "Lamb", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 114 }, { "item": { "version": 5, "typedId": "2147484239.P", "sku": "MB-0019", "label": "Tomato mild", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "AlertsLogic", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2021-09-24T15:14:49", "lastUpdateBy": 2147483754, "attribute1": "Extra", "attribute2": "C", "attribute3": "DG_05", "attribute4": "Maturity", "attribute5": "4013389366459", "attribute6": "0.89", "attribute7": 35000, "attribute8": "2017-01-30", "attribute9": "Topping", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 113 }, { "item": { "version": 3, "typedId": "2147484240.P", "sku": "MB-0020", "label": "Tomato hot", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "UserEntryLogic", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Extra", "attribute2": "C", "attribute3": "DG_04", "attribute4": "Maturity", "attribute5": "4013389366460", "attribute6": "1.09", "attribute7": 30000, "attribute8": "2017-01-20", "attribute9": "Topping", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 112 }, { "item": { "version": 3, "typedId": "2147484230.P", "sku": "MB-0010", "label": "Sausage BS", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": "Q_parameter_details", "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Sausage", "attribute2": "C", "attribute3": "DG_01", "attribute4": "Growth", "attribute5": "4013389366450", "attribute6": "5", "attribute7": 10000, "attribute8": "2017-01-01", "attribute9": "Beef", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 100 }, { "item": { "version": 3, "typedId": "2147484231.P", "sku": "MB-0011", "label": "Sausage BM", "unitOfMeasure": "EA", "userGroupEdit": null, "userGroupViewDetails": null, "currency": "EUR", "formulaName": null, "image": null, "createDate": "2018-04-19T14:32:36", "createdBy": 2147483649, "lastUpdateDate": "2019-07-15T11:18:26", "lastUpdateBy": 2147483649, "attribute1": "Sausage", "attribute2": "A", "attribute3": "DG_02", "attribute4": "Maturity", "attribute5": "4013389366451", "attribute6": "6", "attribute7": 11000, "attribute8": "2017-01-01", "attribute9": "Beef", "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null }, "score": 67 } ] } ], "status": 0 } } } } } } } }, "tags": [ "Products" ], "description": "Retrieves recommended Quote items for a customer, segment, or a product.

\nSee also: [Configure Recommended Items](https://knowledge.pricefx.com/configuration-engineer-knowledge-base/how-to/quoting-howto/configure-recommended-items) Knowledge base article.

\nIf the endpoint receives a request data containing a Quote `typedId` and a `QuoteProductFilter` logic is configured in the partition (see [Quote Product Picker Filter Logic](https://pricefx.atlassian.net/wiki/spaces/KB/pages/3790274667/Quote+Product+Picker+Filter+Logic)), then the endpoint will evaluate this logic with the corresponding Quote and gives the resulting `Filter` object to the recommendation model evaluation.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listRecommendationsRequest", "properties": { "data": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "string" } }, "products": { "type": "array", "description": "Specify SKUs that have been already added to the Quote to exclude them from recommendations. Use the **/clicmanager.fetchitemuniquetypes/{typedId}** endpoint to retrieve these SKUs.", "items": { "type": "string" } }, "excludeProducts": { "type": "array", "description": "Specify any products (SKUs) you want to explicitly exclude from recommendations.", "items": { "type": "string" } }, "maxResults": { "type": "integer" }, "typedId": { "type": "string", "description": "`typedId` of the Quote you want to get the recommendations for." } } } }, "required": [ "data" ] }, "examples": { "listRecommendationsRequestExample": { "value": { "data": { "customers": [ "CD-0001" ] } } } } } } } } }, "/clicmanager.fetchitemuniquetypes/{typedId}": { "post": { "summary": "List Unique CLIC Items", "operationId": "post-clicmanager.fetchitemuniquetypes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listUniqueCLICItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "status": { "type": "integer" } } } } }, "examples": { "listUniqueCLICitemsRequestExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-96569b957-fmkxp", "data": [ [ "AK_0001", "B-0006" ] ], "status": 0 } } } } } } } }, "tags": [ "Clicmanager" ], "description": "Returns all SKUs for the given Calculable Line Item Collection (CLIC).

\n>This endpoint is used in the **REACT** version only. It is not advisable to mix REACT endpoints together with Ember endpoints.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ] }, "/compensation.createsignature/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.CO" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Compensation whose data you want to send via the e-signature system." } ], "post": { "summary": "Send a Document to Sign", "operationId": "post-compensation.createsignature-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "createSignatureResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "integer" } } } } }, "examples": { "createSignatureResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6bdcf77bcd-9c7tx", "data": [ { "version": 23, "typedId": "27.CO", "uniqueName": "CO-27", "label": "New Compensation Plan", "targetDate": "2022-11-18", "workflowStatus": "APPROVED", "headerText": null, "inputs": null, "viewState": null, "outputs": null, "lastUpdateByName": "ondrej.tesar", "createdByName": "ondrej.tesar", "submittedByName": "ondrej.tesar", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "originDeleted": false, "originLabel": null, "originUniqueName": null, "signature": { "status": "processing", "sentDateTime": "2022-11-18T11:20:22.0372372Z", "statusChangedDateTime": "2022-11-18T11:20:22.0372372Z", "customerName": "Ondrej Tesar", "customerUserOrEmail": "ondrej.tesar@pricefx.eu", "sender": 2147490187, "senderName": "Ondrej Tesar", "templateName": "Word", "note": "msg" }, "lineItems": [], "sellerGroup": null, "customerGroup": null, "productGroup": null, "startDate": "2022-11-18", "endDate": "2022-11-18", "payoutDate": "2022-11-18", "compensationRecordSetId": null, "compensationRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "externalRef": null, "originClicId": null, "compensationStatus": "APPROVED", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]", "renderInfo": null, "serverMessagesExtended": null, "approvedByName": "ondrej.tesar", "deniedByName": null, "hasWorkflowHistory": true, "createDate": "2022-11-18T11:01:15", "createdBy": 2147490187, "lastUpdateDate": "2022-11-18T11:04:24", "lastUpdateBy": 2147490187, "supersededBy": null, "prevRev": null, "rootUniqueName": "CO-27", "compensationHeaderType": "__DEFAULT__" } ], "status": 0 } } } } } } } }, "description": "Sends the template with the specified Compensation document data via the e-signature system (DocuSign) and returns the Compensation object.", "tags": [ "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "createSignatureRequest", "properties": { "data": { "type": "object", "properties": { "templateName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "customerName": { "type": "string" }, "note": { "type": "string" } }, "required": [ "templateName", "customerUserOrEmail", "customerName", "note" ] } } } } } } } }, "/compensation.fetchsignature/{uniqueName}": { "post": { "summary": "Get a Signed Document", "operationId": "post-compensation.fetchsignature", "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "object", "properties": {} } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } }, "filename": { "schema": { "type": "string" } } } } }, "tags": [ "Sales Compensations" ], "description": "Downloads a signed document." }, "parameters": [ { "schema": { "type": "string", "example": "CO-9" }, "name": "uniqueName", "in": "path", "required": true, "description": "A `uniqueName` of the Compensation Plan you want to download a signed file for." } ] }, "/compensation.signaturestatus/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.CO" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Compensation document you want to retrieve the signature status for." } ], "post": { "summary": "Get a Signature Status", "operationId": "post-compensation.signaturestatus-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getSignatureStatusResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Compensation" } }, "status": { "type": "integer" } } } } }, "examples": { "getSignatureStatusResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6bdcf77bcd-fkdkt", "data": [ { "version": 23, "typedId": "27.CO", "uniqueName": "CO-27", "label": "New Compensation Plan", "targetDate": "2022-11-18", "workflowStatus": "APPROVED", "headerText": null, "inputs": null, "viewState": null, "outputs": null, "lastUpdateByName": "ondrej.tesar", "createdByName": "ondrej.tesar", "submittedByName": "ondrej.tesar", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "originDeleted": false, "originLabel": null, "originUniqueName": null, "signature": { "status": "processing", "sentDateTime": "2022-11-18T11:20:22.0372372Z", "statusChangedDateTime": "2022-11-18T11:20:22.0372372Z", "customerName": "Ondrej Tesar", "customerUserOrEmail": "ondrej.tesar@pricefx.eu", "sender": 2147490187, "senderName": "Ondrej Tesar", "templateName": "Word", "note": "msg" }, "lineItems": [], "sellerGroup": null, "customerGroup": null, "productGroup": null, "startDate": "2022-11-18", "endDate": "2022-11-18", "payoutDate": "2022-11-18", "compensationRecordSetId": null, "compensationRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "externalRef": null, "originClicId": null, "compensationStatus": "APPROVED", "readOnlyLineItemClass": "net.pricefx.domain.CompensationReadOnlyLineItem", "conditionTypeClass": "net.pricefx.domain.CompensationConditionType", "formulaElementGroup": "compensation", "formulaElementGroupReadOnly": "compensationReadOnly", "successfulCalculationMsg": "COMPENSATION_CALCULATED", "calculationWithErrorsMsg": "COMPENSATION_CALCULATED_WITHERRORS", "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]", "renderInfo": null, "serverMessagesExtended": null, "approvedByName": "ondrej.tesar", "deniedByName": null, "hasWorkflowHistory": true, "createDate": "2022-11-18T11:01:15", "createdBy": 2147490187, "lastUpdateDate": "2022-11-18T11:04:24", "lastUpdateBy": 2147490187, "supersededBy": null, "prevRev": null, "rootUniqueName": "CO-27", "compensationHeaderType": "__DEFAULT__" } ], "status": 0 } } } } } } } }, "tags": [ "Sales Compensations" ], "description": "Returns the Compensation object (`CO`) with the updated signature status (possible values: `sent`, `delivered`, `signed`, `completed`, `declined`, `voided`, `processing`, `error`, `cancelling`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/clicmanager.setlostreason/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147493285.Q" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Quote you want set as lost." } ], "post": { "summary": "Mark an Offer as Lost (with reason)", "operationId": "post-clicmanager.setlostreason-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "markOfferLostWithReasonResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "status": { "type": "integer" } } } } }, "examples": { "markOfferLostWithReasonResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-689d96f98d-hnkt9", "data": [ { "version": 17, "typedId": "2147493285.Q", "uniqueName": "P-2147493285", "label": "New Quote", "targetDate": "2022-11-18", "workflowStatus": "NO_APPROVAL_REQUIRED", "inputs": null, "viewState": null, "outputs": null, "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": "FINISHED", "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "originDeleted": false, "originLabel": null, "originUniqueName": null, "signature": null, "expiryDate": "2022-11-18", "externalRef": null, "customerId": null, "customerName": null, "originClicId": null, "lostReason": "Reason2", "lostReasonComment": "lost", "customerGroup": null, "quoteStatus": "LOST", "approvalRequiredEmailAttachmentsJson": "[{\"fieldName\":\"id\",\"operator\":\"inSet\",\"value\":[],\"_constructor\":\"AdvancedCriteria\"}]", "renderInfo": null, "serverMessagesExtended": null, "approvedByName": "admin", "deniedByName": null, "hasWorkflowHistory": false, "createDate": "2022-11-18T14:21:47", "createdBy": 2147490696, "lastUpdateDate": "2022-11-18T14:22:41", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "P-2147493285", "quoteType": "__DEFAULT__", "status": "DRAFT" } ], "status": 0 } } } } } } } }, "tags": [ "Clicmanager", "Quotes" ], "description": "Sets the specified Quote as `LOST` and sets the loss reason (`lostReason`). Optionally, an additional comment (`lostReasonComment`) can be added.
\nReturns the updated Quote object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "markOfferLostWithReasonRequest", "properties": { "data": { "type": "object", "required": [ "lostReason" ], "properties": { "lostReason": { "type": "string", "description": "The name of the lost reason. The name of the reason must be set in **Administration** > **Configuration** > **Quoting** > **Quote Reasons**." }, "lostReasonComment": { "type": "string", "description": "An additional comment." } } } }, "required": [ "data" ] } } } } } }, "/calculationgridmanager.addgrid": { "post": { "summary": "Add a Calculation Grid", "tags": [ "Calculation Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "addCalculationGridResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ { "version": 0, "typedId": "3.CG", "targetDate": "2022-11-23", "label": "CGtest", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "nodeId": null, "relativeTargetDateDays": null, "userGroupEdit": null, "userGroupViewDetails": null, "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "calculationGridType": null, "keySize": 0, "createdByName": null, "lastUpdateByName": null, "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147490187, "createDate": "2022-11-23T10:26:52", "createdBy": 2147490187, "lastUpdateDate": "2022-11-23T10:26:52", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "partialCalculationDate": null, "id": 3 } ], "status": 0 } } } } } } } }, "operationId": "post-calculationgridmanager.addgrid", "description": "Creates a Calculation Grid (CG) object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationGridRequest", "properties": { "data": { "type": "object", "properties": { "label": { "type": "string", "description": "The name of the Calculation Grid you want to create." }, "targetDate": { "type": "string", "description": "A target date used for the logic execution. If not specified, the system will use today's date." }, "keyGenerationType": { "type": "string", "maxLength": 255, "enum": [ "DATA_DRIVEN", "LOGIC_DRIVEN", "MANUAL" ] }, "configuration": { "type": "string", "description": "User-defined Calculation Grid parameters." } }, "required": [ "label", "keyGenerationType", "configuration" ] } } }, "examples": { "addCalculationLogicRequestExample": { "value": { "data": { "label": "CGtest", "targetDate": "2022-11-23", "keyGenerationType": "LOGIC_DRIVEN", "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}" } } } } } } } } }, "/fetch/CG": { "post": { "summary": "List Calculation Grids", "tags": [ "Calculation Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationGridsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listCalculationGridsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "startRow": 0, "data": [ { "version": 0, "typedId": "2.CG", "label": "Testing", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"SampleFlexibleCalculationGridKeyLogic\",\"keyLogicElement\":\"Static2Keys\"},\"keyHandlingMode\":\"add-only\",\"calculationLogic\":\"CalculationGridBasic\",\"elementNames\":[],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "createdByName": "vinh.nguyen", "lastUpdateByName": "vinh.nguyen", "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147484789, "createDate": "2022-11-23T07:47:15", "createdBy": 2147484789, "lastUpdateDate": "2022-11-23T07:47:15", "lastUpdateBy": 2147484789, "status": "DRAFT", "id": 2 }, { "version": 0, "typedId": "3.CG", "targetDate": "2022-11-23", "label": "CGtest", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147490187, "createDate": "2022-11-23T10:26:52", "createdBy": 2147490187, "lastUpdateDate": "2022-11-23T10:26:52", "lastUpdateBy": 2147490187, "status": "DRAFT", "id": 3 } ], "endRow": 2, "totalRows": 2, "status": 0 } } } } } } } }, "operationId": "post-fetch-CG", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationGridsRequest" }, "examples": { "listCalculationGridsRequestExample": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "status", "operator": "equals", "value": "SCHEDULED" } ] } } } } } } }, "description": "Retrieves Calculation Grids. A filter can be applied." } }, "/fetch/CG/{id}": { "parameters": [ { "schema": { "type": "string", "example": "9" }, "name": "id", "in": "path", "required": true, "description": "ID of the Calculation Grid you want to retrieve." } ], "post": { "summary": "Get a Calculation Grid", "operationId": "post-fetch-CG-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getCalculationGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "getCalculationGridResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ { "version": 0, "typedId": "3.CG", "targetDate": "2022-11-23", "label": "CGtest", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147490187, "createDate": "2022-11-23T10:26:52", "createdBy": 2147490187, "lastUpdateDate": "2022-11-23T10:26:52", "lastUpdateBy": 2147490187, "status": "DRAFT", "id": 3 } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Retrieves the Calculation Grid object (specified by ID).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/update/CG": { "post": { "summary": "Update a Calculation Grid", "operationId": "post-update-CG", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateCalculationGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "updateCalculationGridResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5c8bbcc5b8-8fjcc", "data": [ { "version": 4, "typedId": "2.CG", "targetDate": "2022-11-30", "label": "New Label2", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"SampleFlexibleCalculationGridKeyLogic\",\"keyLogicElement\":\"Skus\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\",\"SwitchSKUContext\",\"EURMoneyResult\",\"Timestamp\",\"NumericResult\",\"Keys\",\"BatchInfo\",\"CPSearch\",\"StringResult\",\"RandomException\",\"Alerts\",\"LinkResult\",\"DefaultAttributedResult\",\"IntegerResult\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "nodeId": null, "relativeTargetDateDays": null, "userGroupEdit": null, "userGroupViewDetails": null, "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keyType": null, "keySize": 0, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "keyGenerationType": "LOGIC_DRIVEN", "updatedBy": 2147490187, "updateDate": "2022-11-30", "createDate": "2022-11-30T09:44:37", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T09:52:36", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "partialCalculationDate": null, "id": 2 } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Updates `label` of the specified Calculation Grid.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCalculationGridRequest", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "label": { "type": "string" } } }, "oldValues": { "$ref": "#/components/schemas/CalculationGrid" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } } }, "examples": { "updateCalculationGridRequestExample": { "value": { "data": { "typedId": "2.CG", "label": "New Label2" }, "oldValues": { "version": 1, "typedId": "2.CG", "targetDate": "2022-11-30", "label": "CG", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"SampleFlexibleCalculationGridKeyLogic\",\"keyLogicElement\":\"Skus\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\",\"SwitchSKUContext\",\"EURMoneyResult\",\"Timestamp\",\"NumericResult\",\"Keys\",\"BatchInfo\",\"CPSearch\",\"StringResult\",\"RandomException\",\"Alerts\",\"LinkResult\",\"DefaultAttributedResult\",\"IntegerResult\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "createdByName": "ondrej.tesar", "keyGenerationType": "LOGIC_DRIVEN", "updatedBy": 2147490187, "updateDate": "2022-11-30", "createDate": "2022-11-30T09:44:37", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T09:44:37", "lastUpdateBy": 2147490187, "status": "DRAFT", "id": 2 }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/delete/CG": { "post": { "summary": "Delete a Calculation Grid", "operationId": "post-delete-CG", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteCalculationGridResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-68f6478894-sl8ts", "data": [ { "version": 4, "typedId": "2.CG", "targetDate": "2022-11-30", "label": "New Label2", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"SampleFlexibleCalculationGridKeyLogic\",\"keyLogicElement\":\"Skus\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\",\"SwitchSKUContext\",\"EURMoneyResult\",\"Timestamp\",\"NumericResult\",\"Keys\",\"BatchInfo\",\"CPSearch\",\"StringResult\",\"RandomException\",\"Alerts\",\"LinkResult\",\"DefaultAttributedResult\",\"IntegerResult\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "nodeId": null, "relativeTargetDateDays": null, "userGroupEdit": null, "userGroupViewDetails": null, "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keyType": null, "keySize": 0, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "keyGenerationType": "LOGIC_DRIVEN", "updatedBy": 2147490187, "updateDate": "2022-11-30", "createDate": "2022-11-30T09:44:37", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T09:52:36", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "partialCalculationDate": null, "id": 2 } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Deletes the specified Calculation Grid. Returns the deleted CG object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationGridRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "deleteCalculationGridRequestExample": { "value": { "data": { "typedId": "23.CG" } } } } } } } } }, "/calculationgridmanager.calculate/{id}": { "parameters": [ { "schema": { "type": "string", "example": "99" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Calculation Grid you want to calculate." } ], "post": { "summary": "Calculate a Calculation Grid", "operationId": "post-calculationgridmanager.calculate-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "calculateCalculationGridResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "calculateCalculationGridResponseExample": { "value": { "response": { "node": "e2e-tabasco-node", "data": [ { "version": 0, "typedId": "2148039383.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "CALCULATIONGRID", "targetObject": "7.CG", "jobName": "CG", "concurrencyKey": "7.CG", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "CG", "uuid": "X5aD5", "calculableObjectTypedId": "7.CG", "queueName": "X5aD5", "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "5VbbQKkCm0", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2022-11-30T15:31:05", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T15:31:05", "lastUpdateBy": 2147490187, "parameters": null, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148039383 } ], "status": 0 } } } } } } } }, "description": "Start the calculation job of the specified Calculation Grid. Returns the `JobStatusTracker` object (JST).", "tags": [ "Calculation Grids" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "calculateCalculationGridRequest", "properties": { "priority": { "type": "integer", "description": "A user-defined priority.", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "example": 0 } } }, "examples": { "example-1": { "value": { "priority": 0 } } } } } } } }, "/optimization.modelfetchpci": { "post": { "summary": "List Parallel Calculation Items", "operationId": "post-optimization.modelfetchpci", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listParallelCalculationItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParallelCalculationItem" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listParallelCalculationItemsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5cf55f5475-fsn4h", "startRow": 0, "data": [ { "version": 1, "typedId": "413215.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "10", "status": "CALCULATED", "inputs": { "value": 10 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413216.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "1", "status": "CALCULATED", "inputs": { "value": 1 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413217.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "2", "status": "CALCULATED", "inputs": { "value": 2 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413218.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "3", "status": "CALCULATED", "inputs": { "value": 3 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413219.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "4", "status": "CALCULATED", "inputs": { "value": 4 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413220.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "5", "status": "CALCULATED", "inputs": { "value": 5 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413221.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "6", "status": "CALCULATED", "inputs": { "value": 6 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413222.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "7", "status": "CALCULATED", "inputs": { "value": 7 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413223.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "8", "status": "CALCULATED", "inputs": { "value": 8 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 }, { "version": 1, "typedId": "413224.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "9", "status": "CALCULATED", "inputs": { "value": 9 }, "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 } ], "endRow": 10, "totalRows": 10, "status": 0 } } } } } } } }, "tags": [ "Optimization" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listParallelCalculationItemsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "required": [ "criteria" ], "properties": { "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "example": "jstId" }, "operator": { "type": "string" }, "value": { "type": "integer", "description": "The `id` of the job.", "example": 2153717967 } }, "required": [ "fieldName", "operator", "value" ] } }, "operator": { "type": "string" }, "_constructor": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "listParallelCalculationItemsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "criteria": [ { "fieldName": "jstId", "operator": "equals", "value": 2153717967 } ], "operator": "and", "_constructor": "AdvancedCriteria" } } } } } } }, "description": "Retrieves all PCI objects (Parallel Calculation Items) for the specified job. A lightweight version of the general **fetch/PCI** endpoint. Does not return possibly large `outputs` and `messages` fields." } }, "/fetch/PCI/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Parallel Calculation Item (PCI) you want to retrieve." } ], "post": { "summary": "Get a Parallel Calculation Item", "operationId": "post-fetch-PCI-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getParallelCalculationItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParallelCalculationItem" } }, "status": { "type": "integer" } } } } }, "examples": { "getParallelCalculationItemResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5cf55f5475-fsn4h", "data": [ { "version": 1, "typedId": "413215.PCI", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "jstId": 2153717967, "key": "10", "status": "CALCULATED", "inputs": { "value": 10 }, "outputs": [ { "resultName": "Item", "resultLabel": "Item", "result": 20, "excludeFromExport": false, "displayOptions": 16, "resultType": "SIMPLE", "overrideAllowEmpty": true, "overridable": false, "overridden": false } ], "messages": [ "__TRACE__---------------------------------------------------------\nDuration (ms) Count Execution element\n---------------------------------------------------------\n 31.41 100% ██████████ 1 └── SLAVE-YMQH3-ctAHv-item-215232\n 31.39 100% █████████▓ 1 └── execute(POAI_Test_Calc_Parallel)\n 0.10 0% ░░░░░░░░░░ 1 ├── get\n 2.06 7% ▓░░░░░░░░░ 1 ├── search.ApplicationProperties\n 25.92 83% ████████░░ 1 └── POAI_Test_Calc_Parallel\n 0.60 2% ░░░░░░░░░░ 1 ├── POS.flush\n 1.86 6% ▓░░░░░░░░░ 1 ├── AbortSyntaxCheck\n 1.41 4% ░░░░░░░░░░ 1 │ └── search.PricingFormula\n 0.12 0% ░░░░░░░░░░ 1 ├── Initialisation\n 0.55 2% ░░░░░░░░░░ 1 ├── Item\n 0.10 0% ░░░░░░░░░░ 1 └── Summary\n" ], "createDate": "2022-11-23T15:24:38", "createdBy": 2147485367, "lastUpdateDate": "2022-11-23T15:24:38", "lastUpdateBy": 2147485367 } ], "status": 0 } } } } } } } }, "tags": [ "Optimization" ], "description": "Retrieves the Parallel Calculation Item (PCI) object specified by `id` as a path parameter.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getParallelCalculationItemRequest", "properties": {} } } } } } }, "/add/CGI{keyNumber}": { "post": { "summary": "Add a Calculation Grid Item", "operationId": "post-add-CGI6", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGridItem6Key" } }, "status": { "type": "integer" } } } } }, "examples": { "example-1": { "value": { "response": { "node": "e2e-tabasco-node", "data": [ { "version": 0, "typedId": "2.CGI6", "label": null, "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "resultSignificantValue": null, "previousSignificantValue": null, "significantValueChange": null, "significantValueChangePct": null, "manualResultSignificantValue": null, "calculatedResultSignificantValue": null, "calculationGridId": 7, "manualEditVersion": 0, "tableId": null, "name": "1 | q | 2 | aa | q | u", "createDate": "2022-11-30T12:26:09", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T12:26:09", "lastUpdateBy": 2147490187, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "manualEditUser": null, "key1": "1", "key2": "q", "key3": "2", "key4": "aa", "key5": "q", "key6": "u", "completeResultsAvailable": false, "itemExtensions": {} } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Adds a new record (CGI) to the Calculation Grid.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addCalculationGridItemRequest", "properties": { "data": { "anyOf": [ { "$ref": "#/components/schemas/CalculationGridItem1Key" }, { "$ref": "#/components/schemas/CalculationGridItem2Key" }, { "$ref": "#/components/schemas/CalculationGridItem3Key" }, { "$ref": "#/components/schemas/CalculationGridItem4Key" }, { "$ref": "#/components/schemas/CalculationGridItem5Key" }, { "$ref": "#/components/schemas/CalculationGridItem6Key" } ] } } }, "examples": { "addCalculationGridItemRequestExample": { "value": { "data": { "key1": "1", "key2": "q", "key3": "2", "key4": "aa", "key5": "q", "key6": "u", "calculationGridId": 7 } } } } } } } }, "parameters": [ { "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "example": "6" }, "name": "keyNumber", "in": "path", "required": true, "description": "Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys." } ] }, "/fetch/CGI{keyNumber}": { "parameters": [ { "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ] }, "name": "keyNumber", "in": "path", "required": true, "description": "Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys." } ], "post": { "summary": "List Calculation Grid Items", "operationId": "post-fetch-CGI-keyNumber", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationGridItemsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CalculationGridItem1Key" }, { "$ref": "#/components/schemas/CalculationGridItem2Key" }, { "$ref": "#/components/schemas/CalculationGridItem3Key" }, { "$ref": "#/components/schemas/CalculationGridItem4Key" }, { "$ref": "#/components/schemas/CalculationGridItem5Key" }, { "$ref": "#/components/schemas/CalculationGridItem6Key" } ] } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Retrieves all Calculation Grid Items for the specified Calculation Grid.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "listCalculationGridItemsRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "required": [ "calculationGridId" ], "properties": { "calculationGridId": { "type": "string", "description": "`id` of the Calculation Grid you want to retrieve Calculation Grid Items for." } } } }, "required": [ "data" ] }, "examples": { "listCalculationGridItemsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "calculationGridId": "7" } } } } } } } } }, "/fetch/CGI{keyNumber}/{id}": { "parameters": [ { "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ] }, "name": "keyNumber", "in": "path", "required": true, "description": "Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys." }, { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Calculation Grid Item you want to fetch." } ], "post": { "summary": "Get a Calculation Grid Item", "operationId": "post-fetch-CGI-keyNumber-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CalculationGridItem6Key" }, { "$ref": "#/components/schemas/CalculationGridItem5Key" }, { "$ref": "#/components/schemas/CalculationGridItem4Key" }, { "$ref": "#/components/schemas/CalculationGridItem3Key" }, { "$ref": "#/components/schemas/CalculationGridItem2Key" }, { "$ref": "#/components/schemas/CalculationGridItem1Key" } ] } }, "status": { "type": "integer" } } } } }, "examples": { "getCalculationGridItemResponseExample": { "value": { "response": { "node": "e2e-tabasco-node", "data": [ { "version": 0, "typedId": "4.CGI6", "calculationGridId": 7, "manualEditVersion": 0, "name": "2 | q | 2 | aa | w | u", "createDate": "2022-11-30T12:45:54", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T12:45:54", "lastUpdateBy": 2147490187, "key1": "2", "key2": "q", "key3": "2", "key4": "aa", "key5": "w", "key6": "u", "completeResultsAvailable": false, "itemExtensions": {} } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Retrieves the Calculation Grid Item record (CGI).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/calculationgridmanager.update/{id}": { "parameters": [ { "schema": { "type": "string", "example": "6" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Calculation Grid Item you want to update." } ], "post": { "summary": "Update a Calculation Grid Item", "operationId": "post-calculationgridmanager.update-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGridItem6Key" } }, "status": { "type": "integer" } } } } }, "examples": { "updateCalculationGridItemResponseExample": { "value": { "response": { "node": "e2e-tabasco-node", "data": [ { "version": 4, "typedId": "4.CGI6", "label": null, "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "resultSignificantValue": null, "previousSignificantValue": null, "significantValueChange": null, "significantValueChangePct": null, "manualResultSignificantValue": null, "calculatedResultSignificantValue": null, "calculationGridId": 7, "manualEditVersion": 0, "tableId": null, "name": "2 | q | 2 | aa | w | newKeyValue", "createDate": "2022-11-30T12:45:54", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T14:52:47", "lastUpdateBy": 2147490187, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "manualEditUser": null, "key1": "2", "key2": "q", "key3": "2", "key4": "aa", "key5": "w", "key6": "newKeyValue", "completeResultsAvailable": false, "itemExtensions": {} } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Allows you to perform a manual override of the specified Calculation Grid Item (CGI). Returns the updated CGIx object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCalculationGridItemRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" }, "key6": { "type": "string" } } }, "oldValues": { "$ref": "#/components/schemas/CalculationGridItem6Key" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "data" ] }, "examples": { "updateCalculationGridItemRequestExample": { "value": { "data": { "typedId": "4.CGI6", "key6": "newKeyValue" }, "oldValues": { "version": 3, "typedId": "4.CGI6", "calculationGridId": 7, "manualEditVersion": 0, "name": "2 | q | 2 | aa | w | b", "createDate": "2022-11-30T12:45:54", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T12:45:54", "lastUpdateBy": 2147490187, "key1": "2", "key2": "q", "key3": "2", "key4": "aa", "key5": "w", "key6": "b", "completeResultsAvailable": false, "itemExtensions": {} }, "operationType": "update", "textMatchStyle": "exact" } } } } } } } }, "/calculationgridmanager.accept/{id}": { "post": { "summary": "Submit a Calculation Grid Item", "operationId": "post-calculationgridmanager.accept", "responses": { "200": { "description": "OK", "x-summary": "OK - In case that more than one item is passed in the request, the body will not contain any data (`\"data\":null`). For a single item, the new CalculationGridItem object is returned.", "content": { "application/json": { "schema": { "type": "object", "title": "submitCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "submitCalculationGridItemResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ { "version": 0, "typedId": "3.CG", "targetDate": "2023-03-30", "label": "CGtest", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147490187, "createDate": "2022-11-23T10:26:52", "createdBy": 2147490187, "lastUpdateDate": "2022-11-23T10:26:52", "lastUpdateBy": 2147490187, "status": "DRAFT", "id": 3 } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "submitCalculationGridItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "ids": { "type": "array", "description": "Specify `typedId`s of items you want to accept.", "items": { "properties": {} } } }, "required": [ "ids" ] } }, "required": [ "data" ] }, "examples": { "submitCalculationGridItemRequestExample": { "value": { "data": { "ids": [ "12.CGI", "13.CGI", "17.CGI", "18.CGI", "19.CGI" ] } } } } } } }, "description": "Submits the `CalculationGridItems` to the workflow.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n CALCULATIONGRID_SUBMIT | Edit Calculation Grid & Add Products (`CALCULATIONGRID_ADD`), Edit CG (`PB_CALCULATIONGRIDEDITOR`), Administer CG (`PB_CALCULATIONGRIDS`)" }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Calculation Grid you want to submit items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint." } ] }, "/calculationgridmanager.reject/{id}": { "post": { "summary": "Deny a Calculation Grid Item", "operationId": "post-calculationgridmanager.reject", "responses": { "200": { "description": "OK", "x-summary": "OK - In case that more than one item is passed in the request, the body will not contain any data (`\"data\":null`). For a single item, the new CalculationGridItem object is returned.", "content": { "application/json": { "schema": { "type": "object", "title": "denyCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGrid" } }, "status": { "type": "integer" } } } } }, "examples": { "denyCalculationGridItemResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5459985ccb-cwdn6", "data": [ { "version": 0, "typedId": "3.CG", "targetDate": "2023-03-30", "label": "CGtest", "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "configuration": "{\"logicDriven\":{\"keyGenerationLogic\":\"KeyLogic_CalculationGrid\",\"keyLogicElement\":\"KeyList_1Keys\"},\"keyHandlingMode\":\"auto\",\"calculationLogic\":\"SampleFlexibleCalculationGridLogic\",\"elementNames\":[\"KeySize\",\"Warning\",\"NumericLongResult\",\"DateResult\",\"MatrixResult\",\"PercentResult\",\"PXSearch\"],\"hiddenElementNames\":[],\"approvalTriggerFields\":[],\"approvalMappings\":{}}", "numberOfApprovedItems": 0, "numberOfOpenItems": 0, "numberOfDeniedItems": 0, "numberOfSubmittedItems": 0, "numberOfAutoApprovedItems": 0, "keySize": 0, "keyGenerationType": "LOGIC_DRIVEN", "updateDate": "2022-11-23", "updatedBy": 2147490187, "createDate": "2022-11-23T10:26:52", "createdBy": 2147490187, "lastUpdateDate": "2022-11-23T10:26:52", "lastUpdateBy": 2147490187, "status": "DRAFT", "id": 3 } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "requestBody": { "content": { "application/json": { "schema": { "description": "", "title": "denyCalculationGridItemRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "ids": { "type": "array", "description": "Specify `typedId`s of items you want to deny.", "items": { "properties": {} } } }, "required": [ "ids" ] } }, "required": [ "data" ] }, "examples": { "denyCalculationGridItemRequestExample": { "value": { "data": { "ids": [ "12.CGI", "13.CGI", "17.CGI", "18.CGI", "19.CGI" ] } } } } } } }, "description": "Denies the `CalculationGridItems` to the workflow.\n\n---\n\nRequired Permission| Roles with the Required Permission |\n---------|----------|\n CALCULATIONGRID_SUBMIT | Edit Calculation Grid & Add Products (`CALCULATIONGRID_ADD`), Edit CG (`PB_CALCULATIONGRIDEDITOR`), Administer CG (`PB_CALCULATIONGRIDS`)" }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "The `id` of the Calculation Grid you want to deny items for. You can retrieve the `id` of the CG, for example, by calling the `/fetch/CG` endpoint." } ] }, "/delete/CGI{keyNumber}": { "parameters": [ { "schema": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ] }, "name": "keyNumber", "in": "path", "required": true, "description": "Use CGI1..CGI6 in the path, where numbers from 1 to 6 refer to Calculation Grid Item keys." } ], "post": { "summary": "Delete a Calculation Grid Item", "operationId": "post-delete-CGI-keyNumber", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationGridItemResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationGridItem6Key" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteCalculationGridItemResponseExample": { "value": { "response": { "node": "e2e-tabasco-node", "data": [ { "version": 4, "typedId": "4.CGI6", "label": null, "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "resultSignificantValue": null, "previousSignificantValue": null, "significantValueChange": null, "significantValueChangePct": null, "manualResultSignificantValue": null, "calculatedResultSignificantValue": null, "calculationGridId": 7, "manualEditVersion": 0, "tableId": null, "name": "2 | q | 2 | aa | w | newKeyValue", "createDate": "2022-11-30T12:45:54", "createdBy": 2147490187, "lastUpdateDate": "2022-11-30T14:52:47", "lastUpdateBy": 2147490187, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "manualEditUser": null, "key1": "2", "key2": "q", "key3": "2", "key4": "aa", "key5": "w", "key6": "newKeyValue", "completeResultsAvailable": false, "itemExtensions": {} } ], "status": 0 } } } } } } } }, "tags": [ "Calculation Grids" ], "description": "Deletes the specified Calculation Grid Item. Returns the deleted CGI object in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteCalculationGridItemRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "description": "`typedId` of the CGI you want to delete.", "example": "99.CGI3" } } }, "operationType": { "type": "string", "example": "remove" } }, "required": [ "data", "operationType" ] }, "examples": { "deleteCalculationGridItemRequestExample": { "value": { "data": { "typedId": "4.CGI6" }, "operationType": "remove" } } } } } } } }, "/datamart.createfc/{fcType}": { "parameters": [ { "schema": { "type": "string", "enum": [ "DMDS", "DMT" ], "example": "DMDS" }, "name": "fcType", "in": "path", "required": true, "description": "The type of FC (FieldCollection) you want to create." } ], "post": { "summary": "Create a DMFieldCollection", "tags": [ "Data Manager" ], "responses": { "200": { "description": "OK" } }, "operationId": "post-datamart.createfc-fcType", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileName": { "type": "array", "format": "binary", "description": "Two files are required – the schema in the JSON format and the data in the AVRO format.", "items": {} } }, "required": [ "fileName" ] } } } }, "description": "Creates a DMFieldCollection from a `multipart/form-data` body containing the **schema** (JSON – the DMFieldCollection DTO) as a first part and the **data** (AVRO format) as second part. Fails if the specified DMFieldCollection already exists.

\nThe first part contains information about the schema of the Field Collenction to be created:
\n- for **DMDataSource**\n - `uniqueName`\n - `label`*\n - `fields`\n- for **DMT**\n - `name`\n - `label`\n - `fields`*\n - `owner `– the ModeObject `typedId `that owns the table.\n\\* `fields` is a list of the DMFields specification.\n\nThe second part contains the table data in the AVRO format. The data schema must comply with the one given in the first part.

\nAn existing table will be overriden (deletes an existing one, creates a new one).\n\n>This is an endpoint dedicated for remote services (such as Optimization Engine or Python Engine). It is very strict by design in order to ensure that the uploaded data ends up exactly in the same format in the platform." } }, "/notification.send": { "post": { "summary": "Send a Validation Message", "operationId": "post-notification.send", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "description": "Sends a validation message (e.g., `api.throwException`, `api.redAlert`, etc.) from the validation of calculation logics in CLIC documents (Quotes, Agreements & Promotions (Contracts), Rebate Agreements, Compensation Plans) to the Notification Center (Notification API).

\nSee the [App Notifications](https://pricefx.atlassian.net/wiki/spaces/KB/pages/6878068738/) article for more details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "notification": { "type": "object", "properties": { "title": { "type": "string" }, "message": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "topic": { "type": "string" }, "actionType": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "dueDate": { "type": "string" }, "dismissible": { "type": "boolean" } }, "required": [ "title", "message", "source", "status", "topic", "actionType" ] } } } } }, "examples": { "sendNotificationRequestExample": { "value": { "data": { "notification": { "title": "My Title", "message": "Description of banner", "source": "notificationBanner", "status": "INFO", "topic": "SYSTEM_NOTIFICATION", "actionType": "INFO_MESSAGE", "validFrom": "2025-06-02T23:00:00.016Z", "validUntil": "2025-06-03T21:59:59.016Z", "dueDate": "2025-06-03T21:59:59.016Z", "dismissible": true } } } } } } } }, "tags": [ "Notifications" ] } }, "/notification.list": { "post": { "summary": "List Notifications", "operationId": "post-notification.list", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listNotificationsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-f75d74cdc-pg5qh", "startRow": 0, "data": [ { "version": 1, "typedId": "937.NTF", "title": "test", "message": "message of the Notification.", "source": "2147493512", "topic": "GROOVY", "status": "WARNING", "actionType": "INFO_MESSAGE", "actionLabel": null, "action": null, "recipientID": 2147490696, "dueDate": "2023-02-26T10:02:00", "validUntil": "2023-01-30T10:02:00", "createDate": "2023-01-27T10:02:59", "createdBy": 2147490696, "lastUpdateDate": "2023-01-27T10:03:15", "lastUpdateBy": 2147490696, "isRead": true }, { "version": 1, "typedId": "936.NTF", "title": "test", "message": "message of the Notification.", "source": "2147493512", "topic": "GROOVY", "status": "WARNING", "actionType": "INFO_MESSAGE", "actionLabel": null, "action": null, "recipientID": 2147490696, "dueDate": "2023-02-26T10:02:00", "validUntil": "2023-01-30T10:02:00", "createDate": "2023-01-27T10:02:59", "createdBy": 2147490696, "lastUpdateDate": "2023-01-27T14:11:11", "lastUpdateBy": 2147490696, "isRead": true } ], "endRow": 300, "totalRows": 2, "status": 0 } } } } } } } }, "tags": [ "Notifications" ], "description": "Retrieves all notifications. A filter can be applied.

\nSee the [App Notifications](https://pricefx.atlassian.net/wiki/display/UNITY/App+Notifications) article for more details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "listNotificationsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "topic", "operator": "equals", "value": "GROOVY" } ] } } } } } } } } }, "/notification.setread": { "post": { "summary": "Mark as Read", "operationId": "post-notification.setread", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "description": "Sets the specifed notification as as read.

\nSee the [App Notifications](https://pricefx.atlassian.net/wiki/display/UNITY/App+Notifications) article for more details.", "tags": [ "Notifications" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } }, "application/xml": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "/notification.delete": { "post": { "summary": "Delete a Notification", "operationId": "post-notification.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "totalRows": { "type": "integer", "description": "A total number of deleted notifications." }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Notifications" ], "description": "Deletes a specified notification.

\nSee the [App Notifications](https://pricefx.atlassian.net/wiki/display/UNITY/App+Notifications) article for more details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string" } } } } } }, "examples": { "deleteNotificationRequestExample": { "value": { "data": { "id": [ "954", "955" ] } } } } } } } } }, "/clicmanager.sendemail": { "post": { "summary": "Send an Email", "operationId": "post-clicmanager.sendemail", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Clicmanager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "sendEmailRequest", "properties": { "data": { "type": "object", "required": [ "typedId", "templateName", "attachmentType", "subject", "recipients" ], "properties": { "typedId": { "type": "string", "description": "`typedId` of the Quote you want to send as an email attachament." }, "templateName": { "type": "string", "description": "A name of the existing template. See the [Publishing Templates](https://pricefx.atlassian.net/wiki/display/UNITY/Publishing+Templates) documentation." }, "attachmentType": { "type": "string", "description": "Select the type of the attachment template.", "enum": [ "WORD", "PDF", "EXCEL" ] }, "subject": { "type": "string" }, "emailText": { "type": "string" }, "attachedFiles": { "type": "string", "description": "`typedId` of the attachment you want to send together with the Quote. This must be an existing attachment. You can upload a file on the **Attachments** tab of the document.", "example": "1147.BD" }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email" ] } } } } }, "required": [ "data" ] }, "examples": { "sendEmailRequestExample": { "value": { "data": { "typedId": "2147491329.Q", "templateName": "word", "attachmentType": "WORD", "subject": "Quote P-2147491329", "emailText": "You can call me at…", "attachedFiles": "1147.BD", "recipients": [ { "name": "admin", "email": "ondrej.tesar@pricefx.com" } ] } } } } } } }, "description": "Sends an email with attached document (e.g., a Quote) to the specified recipients using the [Publishing Template](https://pricefx.atlassian.net/wiki/display/UNITY/Publishing+Templates). You can retrieve available publishing templates calling the `configurationmanager.fetchtemplates/{TypeCode}` endpoint.\n\n### Email Sending Rate Limits and Restrictions\n\nTo prevent misuse, such as email flooding or spam, the following rate limits and restrictions are applied:\n\n**Rate Limiting on `clicmanager.sendemail` Endpoint:**\n - Each user account is restricted to calling this endpoint no more than 5 times (default) within a 5-minute period (default).\n - This limit is counted per partition.\n\n**Recipient Limitation in Payload:**\n - The payload for the `clicmanager.sendemail` endpoint, which specifies recipients limits the number of recipients.\n - A default limit of 20 recipients.\n\nTo change these limits, adjust values for the following options in [Advanced Configuration Options](https://pricefx.atlassian.net/wiki/display/UNITY/Advanced+Configuration+Options+-+Full+List):\n- sendEmailMaxRecipients\n- sendEmailMinutesCountForThrottling\n- sendEmailMaxCountInLastMinutes\n" } }, "/add/RRSC": { "post": { "summary": "Add a Rebate Calculation", "operationId": "post-add-RRSC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addRebateCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordSetCalculation" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Rebate Calculations" ], "description": "Adds a Calculation (`RebateRecordSetCalculation`) for the specified Rebate Record Set.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "label": { "type": "string" }, "rebateRecordSetId": { "type": "integer" } } }, "operationType": { "type": "string" } } }, "examples": { "addRebateCalculation": { "value": { "data": { "label": "Test Calculation", "rebateRecordSetId": 1 }, "operationType": "add" } } } } } } }, "parameters": [] }, "/fetch/RRSC": { "post": { "summary": "List Rebate Calculations", "operationId": "post-fetch-RRSC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listRebateCalculationsResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordSetCalculation" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listRebateCalculationsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-qdj9n", "startRow": 0, "data": [ { "version": 3, "typedId": "1.RRSC", "label": "Default", "calculationMessages": "[\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\"]", "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "createDate": "2019-05-14T08:18:54", "createdBy": 2147483649, "lastUpdateDate": "2020-01-06T18:22:34", "lastUpdateBy": 2147483667, "status": "READY", "calculationStartDate": "2020-01-06T18:22:34", "calculationDate": "2020-01-06T18:22:34", "isDefault": true, "incremental": true, "incCalculationDate": "2020-01-06T18:22:34", "shouldSubmit": false, "valid": true }, { "version": 0, "typedId": "5.RRSC", "label": "Test Calculation", "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "createDate": "2023-03-08T12:18:11", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:18:11", "lastUpdateBy": 2147490187, "status": "DRAFT", "isDefault": false, "incremental": true, "shouldSubmit": false, "valid": true } ], "endRow": 2, "totalRows": 2, "status": 0 } } } } } } } }, "tags": [ "Rebate Calculations" ], "description": "Retrieves Calculation (`RebateRecordSetCalculation`) objects. A filter can be applied.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "integer" } } } } } } } }, "examples": { "listRebateCalculationsRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "rebateRecordSetId", "operator": "equals", "value": 1 } ] } } } } } } } } }, "/rebaterecord.savecalc": { "post": { "summary": "Save a Rebate Calculation", "operationId": "post-rebaterecord.savecalc", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "saveRebateCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordSetCalculation" } }, "status": { "type": "integer" } } } } }, "examples": { "saveRebateCalculationResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-qdj9n", "data": [ { "version": 0, "typedId": "5.RRSC", "targetDate": null, "label": "Test Calculation", "locale": null, "calculationMessages": null, "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "rebateRecordSet": { "version": 0, "typedId": "1.RRS", "targetDate": null, "label": "Default", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "userGroupEdit": null, "userGroupViewDetails": null, "updatedBy": 2147483649, "updateDate": "2019-05-14", "recordSetId": 1, "createDate": "2019-05-14T08:18:54", "createdBy": 2147483649, "lastUpdateDate": "2019-05-14T08:18:54", "lastUpdateBy": 2147483649, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 1 }, "dtoFilter": null, "sortBy": null, "adhocCalculation": null, "calculationConfig": null, "calculationType": null, "createDate": "2023-03-08T12:18:11", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:40:28", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "isDefault": false, "incremental": true, "incCalculationDate": null, "shouldSubmit": false, "valid": true } ], "status": 0 } } } } } } } }, "tags": [ "Rebate Calculations" ], "description": "Updates Calculation details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "saveRebateCalculationRequest", "properties": { "data": { "$ref": "#/components/schemas/RebateRecordSetCalculation" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "oldValues": { "type": "object", "nullable": true } } }, "examples": { "saveRebateCalculation": { "value": { "data": { "version": 0, "typedId": "5.RRSC", "label": "Test Calculation", "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "createDate": "2023-03-08T12:18:11", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:18:11", "lastUpdateBy": 2147490187, "status": "DRAFT", "isDefault": false, "incremental": true, "shouldSubmit": false, "valid": true }, "operationType": "update", "textMatchStyle": "exact", "oldValues": null } } } } } } } }, "/rebaterecord.calculateset": { "post": { "summary": "Run a Rebate Calculation", "tags": [ "Rebate Calculations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "runRebateCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "runRebateCalculationResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7d65f9b656-6t5xd", "data": [ { "version": 0, "typedId": "2148041514.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "REBATERECORD", "targetObject": "5.RRSC", "jobName": "Test Calculation", "concurrencyKey": "5.RRSC", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "RRSC", "uuid": "uWS0N", "calculableObjectTypedId": "5.RRSC", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3734326638", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2023-03-08T12:55:51", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:55:51", "lastUpdateBy": 2147490187, "parameters": "{\"calculation\":\"{\\\"version\\\":0,\\\"typedId\\\":\\\"5.RRSC\\\",\\\"label\\\":\\\"Test Calculation\\\",\\\"rebateRecordSetId\\\":1,\\\"rebateRecordSetLabel\\\":\\\"Default\\\",\\\"rebateRecordSet\\\":{\\\"version\\\":0,\\\"typedId\\\":\\\"1.RRS\\\",\\\"label\\\":\\\"Default\\\",\\\"numberOfItems\\\":0,\\\"keepManualOverrides\\\":false,\\\"writeOnlyChangedItems\\\":false,\\\"updatedBy\\\":2147483649,\\\"updateDate\\\":\\\"2019-05-14\\\",\\\"recordSetId\\\":1,\\\"createDate\\\":\\\"2019-05-14T08:18:54\\\",\\\"createdBy\\\":2147483649,\\\"lastUpdateDate\\\":\\\"2019-05-14T08:18:54\\\",\\\"lastUpdateBy\\\":2147483649,\\\"status\\\":\\\"DRAFT\\\",\\\"id\\\":1},\\\"status\\\":\\\"DRAFT\\\",\\\"isDefault\\\":false,\\\"incremental\\\":true,\\\"shouldSubmit\\\":false,\\\"valid\\\":true}\"}", "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148041514 } ], "status": 0 } } } } } } } }, "operationId": "post-rebaterecord.calculateset", "description": "Starts the calculation job (JST) of the calculation set. Returns the `JobStatusTracker` object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RebateRecordSetCalculation" } } }, "examples": { "runRebateCalculationRequestExample": { "value": { "data": { "version": 0, "typedId": "5.RRSC", "targetDate": null, "label": "Test Calculation", "locale": null, "calculationMessages": null, "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "rebateRecordSet": { "version": 0, "typedId": "1.RRS", "targetDate": null, "label": "Default", "locale": null, "calculationMessages": null, "numberOfItems": 0, "keepManualOverrides": false, "writeOnlyChangedItems": false, "userGroupEdit": null, "userGroupViewDetails": null, "updatedBy": 2147483649, "updateDate": "2019-05-14", "recordSetId": 1, "createDate": "2019-05-14T08:18:54", "createdBy": 2147483649, "lastUpdateDate": "2019-05-14T08:18:54", "lastUpdateBy": 2147483649, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "id": 1 }, "dtoFilter": null, "sortBy": null, "adhocCalculation": null, "calculationConfig": null, "calculationType": null, "createDate": "2023-03-08T12:18:11", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:40:28", "lastUpdateBy": 2147490187, "status": "DRAFT", "calculationStartDate": null, "calculationDate": null, "isDefault": false, "incremental": true, "incCalculationDate": null, "shouldSubmit": false, "valid": true } } } } } } } } }, "/clicmanager.deleteRebateCalculation": { "post": { "summary": "Delete a Rebate Calculation", "tags": [ "Rebate Calculations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteRebateCalculationResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordSetCalculation" } }, "status": { "type": "integer" } } } } }, "examples": { "deleteRebateCalculationResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5bf68c775f-frgl5", "data": [ { "version": 5, "typedId": "5.RRSC", "targetDate": null, "label": "Test Calculation", "locale": null, "calculationMessages": "[\"Rebate Agreement calculated successfully\",\"Missing Condition Type on InlineConfiguratorWithInputMatrixEntriesRO_RBA\",\"Missing Condition Type on InlineConfiguratorWithInputMatrixEntriesRW_RBA\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\",\"Rebate Agreement calculated successfully\"]", "rebateRecordSetId": 1, "rebateRecordSetLabel": "Default", "rebateRecordSet": null, "dtoFilter": null, "sortBy": null, "adhocCalculation": null, "calculationConfig": null, "calculationType": null, "createDate": "2023-03-08T12:18:11", "createdBy": 2147490187, "lastUpdateDate": "2023-03-08T12:56:09", "lastUpdateBy": 2147490187, "status": "ERROR", "calculationStartDate": "2023-03-08T12:56:05", "calculationDate": "2023-03-08T12:56:09", "isDefault": false, "incremental": true, "incCalculationDate": "2023-03-08T12:56:05", "shouldSubmit": false, "valid": true } ], "status": 0 } } } } } } } }, "operationId": "post-clicmanager.deleteRebateCalculation", "description": "Deletes a Rebate Calculation (the `RebateRecordSetCalculation` object).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteRebateCalculationRequest", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string", "example": "123.RRSC" } } } } }, "examples": { "deleteRebateCalculationRequestExample": { "value": { "data": { "typedId": "123.RRSC" } } } } } } } } }, "/login/extended": { "get": { "summary": "User Login (V1)", "tags": [ "Authentication" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "userLoginResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "status": { "type": "integer" } } } } }, "examples": { "userLoginExampleResponse": { "value": { "response": { "node": "string", "data": [ { "lastName": "string", "lastLogin": "2019-08-24T14:15:22Z", "typedId": "string", "firstLogin": true, "noSession": true, "businessRoles": [ { "version": 0, "typedId": "string", "uniqueName": "string", "label": "string", "roles": [ { "version": 0, "typedId": "string", "uniqueName": "string", "module": "PRICESETTING", "label": "string", "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "groups": [ {} ], "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "customerFilterCriteria": "string", "defaultUserGroupViewDetails": "string", "loginName": "string", "allRoleNames": [ "string" ], "receiveAdminEmail": true, "wizardDashboardName": "string", "email": "string", "createDate": "2019-08-24T14:15:22Z", "additionalInfo4": "string", "additionalInfo3": "string", "additionalInfo2": 0, "additionalInfo1": 0, "passwordExpiry": "string", "allGroups": [ {} ], "groups": [ { "version": 0, "typedId": "string", "uniqueName": "string", "label": "string", "additionalInfo1": 0, "additionalInfo2": 0, "additionalInfo3": "string", "additionalInfo4": "string", "createDate": "string", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "productFilterCriteria": "string", "version": 0, "ssoOnly": true, "firstName": "string", "defaultUserGroupEdit": "string", "emailLocale": "string", "workflowEmailingActivated": true, "createdBy": 0, "roleNames": [ "string" ], "requireTFA": true, "activated": true, "lastUpdateBy": 0, "extendedData": { "property1": "string", "property2": "string" } } ], "status": 0 } } } } } } } }, "operationId": "get-login", "description": "Authenticates a user. When the user is authenticated, the logged-in user's details (including all roles and permissions) are returned in the response body.\n\nCSRF check is not performed by this endpoint, because the user is authenticated using the basic HTTP auth.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } }, "parameters": [] }, "/dcrmanager.add": { "post": { "summary": "Add a Data Change Request", "operationId": "post-dcrmanager.add", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addDCRResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequest" } }, "status": { "type": "integer" } } } } }, "examples": { "addDCRResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-78fc875d6f-lpdr4", "data": [ { "version": 2, "typedId": "66.DCR", "uniqueName": "DCR-66", "label": "DCR_P", "approvalState": "NOT_APPROVED", "approvalDate": null, "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "workflowStatus": "DRAFT", "dcrTypeName": "DCRT", "userGroupEdit": null, "userGroupViewDetails": null, "dcrTargetType": "P", "dcrTargetInfo": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "createDate": "2023-06-02T11:41:45", "createdBy": 2147490696, "lastUpdateDate": "2023-06-02T11:41:45", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Adds a new Data Change Request using the specified Data Change Request Type and label.", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addDCRRequest", "properties": { "data": { "type": "object", "properties": { "dcrTypeName": { "type": "string" }, "label": { "type": "string" } }, "required": [ "dcrTypeName" ] }, "operationType": { "type": "string" } } }, "examples": { "addDCRRequestExample": { "value": { "data": { "dcrTypeName": "DCRT", "label": "DCR_P" }, "operationType": "add" } } } } } } } }, "/dcrmanager.add/{id}": { "post": { "summary": "Add a Data Change Request Item", "operationId": "post-dcrmanager.add-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addDCRIResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestItem" } }, "status": { "type": "integer" } } } } }, "examples": { "addDCRIResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7577dc88d5-2jm5z", "data": [ { "version": 0, "typedId": "38.DCRI", "itemTypedId": null, "name": null, "value": null, "key1": null, "key2": null, "key3": null, "key4": null, "key5": null, "key6": null, "sku": "12345", "customerId": null, "sellerId": null, "label": null, "unitOfMeasure": null, "currency": null, "comments": null, "deleteRow": false, "ignoreChange": false, "approvalReason": null, "oldValues": null, "changeRef": null, "changeRequestId": 66, "createDate": "2023-06-02T13:20:29", "createdBy": 2147490696, "lastUpdateDate": "2023-06-02T13:20:29", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } } }, "description": "Adds a new Data Change Request Item (DCRI) to the DCR.", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addDCRIRequest", "properties": { "data": { "type": "object", "required": [ "sku" ], "properties": { "sku": { "type": "string" } } }, "operationType": { "type": "string" } }, "required": [ "data", "operationType" ] }, "examples": { "addDCRIRequestExample": { "value": { "data": { "sku": "12345" }, "operationType": "add" } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request you want to add the Data Change Request Item to." } ] }, "/dcrmanager.fetch/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request you want to retrieve." } ], "post": { "summary": "Get a Data Change Request", "operationId": "post-dcrmanager.fetch-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getDCRResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestItem" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getDCRRequest", "properties": { "endRow": { "type": "integer" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" } }, "required": [ "endRow", "operationType", "startRow", "textMatchStyle" ] }, "examples": { "getDCRRequestExample": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } } }, "description": "Retrieves details (items) of the specified Data Change Request." } }, "/dcrmanager.fetch/{id}/changesOnly": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request you want to retrieve changed items for." } ], "post": { "summary": "Get a Data Change Request (changes only)", "operationId": "post-dcrmanager.fetch-id-changesOnly", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getDCRResponseChangeOnly", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestItem" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "getDCRResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7577dc88d5-pztr7", "startRow": 0, "data": [ { "version": 1, "typedId": "38.DCRI", "itemTypedId": null, "name": null, "value": null, "key1": null, "key2": null, "key3": null, "key4": null, "key5": null, "key6": null, "sku": "12345", "customerId": null, "sellerId": null, "label": null, "unitOfMeasure": null, "currency": null, "comments": "a test comment", "deleteRow": false, "ignoreChange": false, "approvalReason": null, "oldValues": null, "changeRef": null, "changeRequestId": 66, "createDate": "2023-06-02T13:20:29", "createdBy": 2147490696, "lastUpdateDate": "2023-06-02T13:21:20", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "getDCRRequestChangeOnly", "properties": { "endRow": { "type": "integer" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" } }, "required": [ "endRow", "operationType", "startRow", "textMatchStyle" ] }, "examples": { "getDCRRequestExample": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } } }, "description": "Retrieves changed items of the specified Data Change Request." } }, "/dcrmanager.update/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request whose item you want to update." } ], "post": { "summary": "Update a Data Change Request Item", "operationId": "post-dcrmanager.update-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateDCRIResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestItem" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Data Change Requests" ], "description": "Updates a Data Change Request Item (DCRI).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateDCRIRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string", "description": "`typedId` of the item you want to update." }, "currency": { "type": "string" } } }, "oldValues": { "$ref": "#/components/schemas/DataChangeRequestItem" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } }, "required": [ "data", "oldValues" ] } } } } } }, "/dcrmanager.delete/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request whose item you want to delete." } ], "post": { "summary": "Delete a Data Change Request Item", "operationId": "post-dcrmanager.delete-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteDCRIResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestItem" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Data Change Requests" ], "description": "Removes the item from the specified Data Change Request.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteDCRIRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" } } }, "operationType": { "type": "string" } }, "required": [ "data", "operationType" ] } } } } } }, "/dcrmanager.submit/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the DCR to be submitted." } ], "post": { "summary": "Submit a Data Change Request", "operationId": "post-dcrmanager.submit-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "submitDCRResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequest" } }, "status": { "type": "integer" } } } } }, "examples": { "submitDCRResponseExample": { "value": { "response": { "node": "e2e-node", "data": [ { "version": 5, "typedId": "66.DCR", "uniqueName": "DCR-66", "label": "Data Change Request - P", "approvalState": "APPROVED", "approvalDate": "2023-09-07T11:16:17.491036867", "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "workflowStatus": "NO_APPROVAL_REQUIRED", "dcrTypeName": "DCRT", "userGroupEdit": null, "userGroupViewDetails": null, "dcrTargetType": "P", "dcrTargetInfo": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "approvedByName": "admin", "createDate": "2023-09-07T11:09:41", "createdBy": 2147490696, "lastUpdateDate": "2023-09-07T11:16:17", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Data Change Requests" ], "description": "Submits the specified Data Change Request (DCR).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/dcrmanager.submit/{id}/async": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the DCR to be submitted." } ], "post": { "summary": "Submit a Data Change Request (async)", "operationId": "post-dcrmanager.submit-id-async", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "submitDCRAsyncResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "submitDCRAsyncResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-64c5f8d7f5-k5svk", "data": [ { "version": 0, "typedId": "2148045777.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "DCR_SUBMIT", "targetObject": "67.DCR", "jobName": "DCR-67", "concurrencyKey": "67.DCR", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "DCR", "uuid": "NoQwz", "calculableObjectTypedId": "67.DCR", "queueName": null, "runNumber": 0, "partitionName": "companypartition", "partitionUUID": "6562656564", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2023-09-07T12:46:04", "createdBy": 2147490696, "lastUpdateDate": "2023-09-07T12:46:04", "lastUpdateBy": 2147490696, "parameters": null, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148045777 } ], "status": 0 } } } } } } } }, "tags": [ "Data Change Requests" ], "description": "Asynchronously submits the specified Data Change Request (DCR). Returns the *Job Status Tracker* object (JST).

\nUse to submit large (set by `asyncSubmitDCRThreshold` via *Advanced Configuration Options*) DCRs to avoid system timeouts (180 seconds - AWS).
\n`asyncSubmitDCRThreshold` default is set 100. If the key does not exist, the submit is always synchronous.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/dcrmanager.addmassop/{id}": { "post": { "summary": "Mass Edit Data Change Request Items", "operationId": "post-dcrmanager.addmassop-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestMassChange" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-86fdbbfb9-7zjkq", "data": [ { "version": 0, "typedId": "41.DCRMC", "massChange": { "definitions": [ { "fieldName": "currency", "fieldValue": "USD", "massEditOperator": "=", "itemAction": "edit", "changeStateReason": null, "precision": null } ], "filter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "id", "value": [ "2147506300", "2147506301" ], "operator": "inSet" } ], "operator": "and" }, "type": "EDIT" }, "comments": null, "createDate": "2024-05-06T10:22:39", "createdBy": 2147490696, "lastUpdateDate": "2024-05-06T10:22:39", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Creates a new Mass Change record (DataChangeRequestMassChange).", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "description": "IDs of items you want to mass edit.", "items": { "type": "string" } }, "_constructor": { "type": "string" } } } } } }, "massEditRecords": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "massEditOperator": { "type": "string" }, "fieldValue": { "type": "string" }, "precision": { "type": "number", "nullable": true } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "2147506300", "2147506301" ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "currency", "massEditOperator": "=", "fieldValue": "USD", "precision": null } ] } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request." } ] }, "/dcrmanager.fetchmassop/{id}": { "post": { "summary": "Get Data Change Request Mass Changes", "operationId": "post-dcrmanager.fetchmassop-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestMassChange" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-86fdbbfb9-7zjkq", "data": [ { "version": 0, "typedId": "41.DCRMC", "massChange": { "definitions": [ { "fieldName": "currency", "fieldValue": "USD", "massEditOperator": "=", "itemAction": "edit", "changeStateReason": null, "precision": null } ], "filter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "id", "value": [ "2147506300", "2147506301" ], "operator": "inSet" } ], "operator": "and" }, "type": "EDIT" }, "comments": null, "createDate": "2024-05-06T10:22:39", "createdBy": 2147490696, "lastUpdateDate": "2024-05-06T10:22:39", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Retrieves Mass Change records (DataChangeRequestMassChange).", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "nullable": true, "properties": { "endRow": { "type": "integer" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" } } }, "examples": { "Example 1": { "value": { "endRow": 300, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request." } ] }, "/dcrmanager.updatemassop/{id}": { "post": { "summary": "Update Data Change Request Mass Changes", "operationId": "post-dcrmanager.updatemassop-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestMassChange" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-86fdbbfb9-7zjkq", "data": [ { "version": 0, "typedId": "41.DCRMC", "massChange": { "definitions": [ { "fieldName": "currency", "fieldValue": "USD", "massEditOperator": "=", "itemAction": "edit", "changeStateReason": null, "precision": null } ], "filter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "id", "value": [ "2147506300", "2147506301" ], "operator": "inSet" } ], "operator": "and" }, "type": "EDIT" }, "comments": null, "createDate": "2024-05-06T10:22:39", "createdBy": 2147490696, "lastUpdateDate": "2024-05-06T10:22:39", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Updates Mass Change records (DataChangeRequestMassChange).", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "massChange": { "type": "object", "properties": { "filter": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } } } } }, "definitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "massEditOperator": { "type": "string" }, "fieldValue": { "type": "string" }, "precision": { "type": "integer", "nullable": true } } } } } } } }, "oldValues": { "$ref": "#/components/schemas/DataChangeRequestMassChange" }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } } }, "examples": { "Example 1": { "value": { "data": { "typedId": "41.DCRMC", "massChange": { "filter": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ "2147506300", "2147506301" ] } ] }, "definitions": [ { "fieldName": "currency", "massEditOperator": "=", "fieldValue": "EUR", "precision": null } ] } }, "oldValues": { "version": 0, "typedId": "41.DCRMC", "massChange": { "definitions": [ { "fieldName": "currency", "fieldValue": "USD", "massEditOperator": "=", "itemAction": "edit", "changeStateReason": null, "precision": null } ], "filter": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "id", "value": [ "2147506300", "2147506301" ], "operator": "inSet" } ], "operator": "and" }, "type": "EDIT" }, "comments": null, "createDate": "2024-05-06T10:22:39", "createdBy": 2147490696, "lastUpdateDate": "2024-05-06T10:22:39", "lastUpdateBy": 2147490696, "itemExtensions": { "cellStyles": { "typedId": "background-color:#ffa39e" } } }, "operationType": "update", "textMatchStyle": "exact" } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request." } ] }, "/dcrmanager.deletemassop/{id}": { "post": { "summary": "Delete a Data Change Request Mass Change", "operationId": "post-dcrmanager.deletemassop-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DataChangeRequestMassChange" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-85b5cf67cc-88t97", "data": [ { "version": 1, "typedId": "41.DCRMC", "massChange": null, "comments": null, "createDate": "2024-05-06T10:22:39", "createdBy": 2147490696, "lastUpdateDate": "2024-05-06T11:53:10", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Deletes specified Mass Change record (DataChangeRequestMassChange).", "tags": [ "Data Change Requests" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } } } } }, "examples": { "Example 1": { "value": { "data": { "typedId": "41.DCRMC" } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the Data Change Request." } ] }, "/actionitem.execute/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "example": "23.AI" }, "name": "TypeCode", "in": "path", "required": true, "description": "The `typeCode` of the Action Item you want to execute the calculation for." } ], "post": { "summary": "Execute a Logic", "operationId": "post-actionitem.execute-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "executeActionItemLogicResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object", "nullable": true }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "string", "nullable": true }, "alertMessage": { "type": "string", "nullable": true }, "alertType": { "type": "string", "nullable": true }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "nullable": true }, "suffix": { "type": "string", "nullable": true }, "resultType": { "type": "string" }, "cssProperties": { "type": "string", "nullable": true }, "userGroup": { "type": "string", "nullable": true }, "resultGroup": { "type": "string", "nullable": true }, "overrideValueOptions": { "type": "string", "nullable": true }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string", "nullable": true }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string", "nullable": true } } } }, "status": { "type": "integer" } } } } }, "examples": { "executeActionItemLogicResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ { "resultName": "DetectionRules", "resultLabel": "Detection Rules", "result": null, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 16, "formatType": null, "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "DetectedInsight", "resultLabel": "Detected Insight", "result": { "layout": null, "entries": [ { "BuyingGroup": "Direct Resource", "BusinessUnit": "Residential and Small Business", "SumOfQuantity": 55433 } ], "columns": [ "BuyingGroup", "BusinessUnit", "SumOfQuantity" ], "defaultFormat": null, "columnFormats": null, "columnTooltips": null, "enableClientFilter": false, "title": null, "preferenceName": null, "preferencesDisabled": false, "sortingDisabled": false, "escapeHTML": false, "columnTranslations": null, "onRowSelectEvents": {}, "backEndActions": [], "resultType": "MATRIX" }, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 16, "formatType": null, "suffix": null, "resultType": "MATRIX", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "status": 0 } } } } } } } }, "tags": [ "Actions" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "description": "Executes a logic for the specified Action Item and returns the result." } }, "/add/AIT": { "post": { "summary": "Add an Action Type", "operationId": "post-add-AIT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "addActionTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItemType" } }, "status": { "type": "integer" } } } } }, "examples": { "addActionTypeResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-85969998d5-pkhfz", "data": [ { "version": 0, "typedId": "29.AIT", "uniqueName": "AITtest", "label": "Action Type Test", "formulaName": null, "userGroupEdit": null, "userGroupViewDetails": null, "configuration": { "name": "Default Actions config", "tabs": [ { "icon": "file-info-alt", "name": "details", "type": "details", "translationKey": "dynamicTab_details" } ] }, "createDate": "2023-06-28T08:22:30", "createdBy": 2147490696, "lastUpdateDate": "2023-06-28T08:22:30", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Action Types" ], "description": "Creates a new Action Type (Action Item Type – `AIT`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "addActionTypeRequest", "properties": { "operation": { "type": "string" }, "data": { "$ref": "#/components/schemas/ActionItemType" } }, "required": [ "operation" ] }, "examples": { "addActionTypeRequestExample": { "value": { "operation": "add", "data": { "configuration": { "name": "Default Actions config", "tabs": [ { "name": "details", "translationKey": "dynamicTab_details", "type": "details", "icon": "file-info-alt" } ] }, "uniqueName": "AITtest", "label": "Action Type Test" } } } } } } } } }, "/fetch/AIT": { "post": { "summary": "List Action Types", "operationId": "post-fetch-AIT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listActionTypesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItemType" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Action Types" ], "description": "Retrieves Action Types (Action Item Types – `AIT`). A filter can be applied.", "requestBody": { "$ref": "#/components/requestBodies/fetchRequest" } } }, "/update/AIT": { "post": { "summary": "Update an Action Type", "operationId": "post-update-AIT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "updateActionTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItemType" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Action Types" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "userGroupViewDetails": { "type": "string" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "configuration": { "type": "object", "properties": { "name": { "type": "string" }, "tabs": { "type": "array", "items": { "type": "object", "properties": { "icon": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "translationKey": { "type": "string" } } } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "_key": { "type": "string" }, "_level": { "type": "integer" } } }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } } }, "examples": { "updateActionTypeRequestExample": { "value": { "data": { "typedId": "29.AIT", "userGroupViewDetails": "PricingManagers" }, "oldValues": { "version": 0, "typedId": "29.AIT", "uniqueName": "AITtest", "label": "Action Type Test", "configuration": { "name": "Default Actions config", "tabs": [ { "icon": "file-info-alt", "name": "details", "type": "details", "translationKey": "dynamicTab_details" } ] }, "createDate": "2023-06-28T08:22:30", "createdBy": 2147490696, "lastUpdateDate": "2023-06-28T08:22:30", "lastUpdateBy": 2147490696, "_key": "29.AIT", "_level": 0 }, "operationType": "update", "textMatchStyle": "exact" } } } } } }, "description": "Updates the Action Type (Action Item Type – `AIT`)." } }, "/delete/AIT": { "post": { "summary": "Delete an Action Item Type", "operationId": "post-delete-AIT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "deleteActionItemTypeResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActionItemType" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Action Types" ], "requestBody": { "$ref": "#/components/requestBodies/deleteRequest" }, "description": "Deletes the specified Action Type (Action Item Type – `AIT`)." } }, "/admin.fetchjst": { "post": { "summary": "List Jobs", "operationId": "post-admin.fetchjst", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listJSTResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "listJobsResponseExample": { "value": { "response": { "node": "string", "startRow": 0, "data": [ { "processingStart": "string", "targetObject": "string", "typedId": "string", "lastUpdateDate": "2019-08-24T14:15:22Z", "trackerType": "PRICELIST", "threadId": 0, "jobSettings": { "distributedAction": { "calculableObjectTypedId": "string", "queueName": "string", "runNumber": 0, "partitionName": "string", "enableDirtyTracking": true, "agentOption1": {}, "jobSize": 0 }, "jobType": "string", "uuid": "string", "calculableObjectTypedId": "string", "queueName": "string", "runNumber": 0, "partitionName": "string", "partitionUUID": "string", "enableDirtyTracking": true, "agentOption1": {}, "jobSize": 0, "distributed": true }, "calculationContext": "string", "threadUUID": "string", "id": 0, "calculationResults": "string", "processingNode": "string", "createDate": "2019-08-24T14:15:22Z", "jobName": "string", "concurrencyKey": "string", "priority": 0, "version": 0, "createdBy": 0, "processingEnd": "string", "progress": "string", "messages": "string", "runNumber": 0, "cancelRequested": true, "parameters": "string", "status": "WAITING_FOR_DISPATCH", "lastUpdateBy": 0 } ], "endRow": 0, "totalRows": 0, "status": 0 } } } } } } } }, "description": "Returns a list of all Job Status Trackers, excluding potentially large `message` field. Use the general `/fetch/JST` endpoint to retrieve JSTs including the `message` field.", "tags": [ "Jobs & Tasks" ], "requestBody": { "$ref": "#/components/requestBodies/fetchRequest" } } }, "/admin.canceljst/{id}": { "parameters": [ { "schema": { "type": "string", "example": "213565549" }, "name": "id", "in": "path", "required": true, "description": "`id` if the job you want to cancel." } ], "post": { "summary": "Cancel a Job", "operationId": "post-admin.canceljst-id", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Jobs & Tasks" ], "description": "Cancels a Job Status Tracker (JST). Only a pending job can be cancelled.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/clicmanager.updatelineitems/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147489828.Q" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the CLIC object (e.g., a Quote) you want to update line items for." } ], "post": { "summary": "Update CLIC Line Items", "operationId": "post-clicmanager.updatelineitems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "typedId": { "type": "string" }, "version": { "type": "integer" }, "lineId": { "type": "string" } } } }, { "type": "object", "properties": { "version": { "type": "integer" } } } ] } }, "status": { "type": "integer" } } } } }, "examples": { "updateCLICLineItemsResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-5db9bf487f-58sbn", "data": [ [ { "typedId": "2147506891.QLI", "version": 1, "lineId": "sLwDZV9j8k1eS3T" }, { "typedId": "2147506890.QLI", "version": 1, "lineId": "dRqBZV9j8k1vD5R" } ], { "version": 11 } ], "status": 0 } } } } } } } }, "tags": [ "Clicmanager", "Contracts (Agreements & Promotions)", "Quotes", "Rebate Agreements", "Sales Compensations" ], "description": "Updates specified line item fields of a CLIC object (Quote, Agreements & Promotions (Contract), Rebate Agreement, or Compensation Plan).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "updateCLICLineItemsRequest", "properties": { "data": { "type": "object", "required": [ "lineItems" ], "properties": { "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string", "description": "`typedId` of the line item you want to update.", "example": "2147526106.QLI" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer" } } } } }, "required": [ "version", "typedId" ] } } } } }, "required": [ "data" ] }, "examples": { "updateCLICLineItemsRequestExample": { "value": { "data": { "lineItems": [ { "version": 1, "typedId": "2147506890.QLI", "inputs": [ { "name": "Quantity", "value": 2 }, { "name": "Quantity", "value": 5 } ] } ] } } } } } } } } }, "/configurationmanager.getexternalappproperties": { "get": { "summary": "Get External Application Properties", "tags": [ "Configuration" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "getexternalapppropertiesResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } }, "status": { "type": "integer" } } } } } } } } }, "operationId": "get-configurationmanager.getexternalappproperties", "description": "Retrieves all `pfxExternalApp` objects (as specified in *Administration* > *Configuration* > *System Configuration* > *Advanced Configuration Options* by the `pfxExternalApp_` prefix.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/importfile/{TypeCode}/{target}/{uploadSlotId}": { "parameters": [ { "schema": { "type": "string", "example": "PX", "enum": [ "PX", "CX", "SX" ] }, "name": "TypeCode", "in": "path", "required": true, "description": "Type code of the table you want to upload the file to." }, { "schema": { "type": "string" }, "name": "target", "in": "path", "required": true, "description": "The name of the PX/CX/SX table." }, { "schema": { "type": "string", "example": "5000" }, "name": "uploadSlotId", "in": "path", "required": true, "description": "`id` of the upload slot. Use the **uploadslotmanager.newuploadslot** endpoint to retrieve the `id`." } ], "post": { "summary": "Upload a File to PX/CX/SX", "operationId": "post-importfile-TypeCode-target-uploadSlotId", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Customer Extensions", "Product Extensions", "Seller Extensions" ], "description": "Uploads **CSV**, or **XLSX** file to Product Extensions, Customer Extensions, or Seller Extensions table.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Provide the file (`CSV`, or `XLSX` format) you want to upload." } } } } }, "description": "" }, "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ], "example": "false" }, "in": "query", "name": "truncate", "description": "Set to `true` to overwrite existing data, or `false` to add new lines to existing data." } ] } }, "/optimization.modelrevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the model you want to revoke." } ], "post": { "summary": "Revoke a Model", "operationId": "post-optimization.modelrevoke-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "revokeModelResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelObject" } }, "status": { "type": "integer" } } } } }, "examples": { "revokeModelResponseExample": { "value": { "response": { "node": "string", "data": [ { "version": 0, "typedId": "string", "uniqueName": "string", "label": "string", "modelClassUN": "string", "moduleCategoryUN": null, "userGroupEdit": null, "userGroupViewDetails": null, "currentStep": "string", "state": { "onetab": { "tab2": { "InlineConfigurator": { "SliderEntry": 0 } } } }, "createdByName": "string", "lastUpdateByName": "string", "submittedBy": 0, "submittedByName": "string", "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": "2023-07-10T11:36:08", "workflowStatus": "WITHDRAWN", "status": "DRAFT", "createDate": "2023-07-10T11:36:08", "createdBy": 0, "lastUpdateDate": "2023-07-10T11:36:08", "lastUpdateBy": 0 } ], "status": 0 } } } } } } }, "400": { "description": "Bad Request. Invalid path." }, "403": { "description": "REVOKE_NOT_ALLOWED" }, "404": { "description": "The model with the specified `typedId` not found." } }, "tags": [ "Optimization" ], "description": "Revokes a model with a workflow so it can be deleted afterward. Only models with the workflow status = `APPROVED` or `NO_APPROVAL_REQUIRED` can be revoked. The revoke action will set the workflow status of a model to `WITHDRAWN`.
\nOnce revoked, the model is back in an editable state and can be deleted by users having the right to do so.

\nRequired roles:\n- `PO_MCMO_MANAGER` (*Administrate Model Classes/Objects*)\n- `PO_MCMO` (*Manage Model Objects*)\n- for models in Module Categories (see [User Group Entitlements in Module Categories](https://pricefx.atlassian.net/wiki/display/UNITY/Module+Categories#User-Group-Entitlements-in-Module-Categories)): `MODULECATEGORY_MO_MANAGER` (*Manage Model in Module Category*)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/customform.preview": { "parameters": [], "post": { "summary": "Preview a Custom Form Workflow", "operationId": "post-customform.preview", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "previewCustomFormWorkflowResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "layout": { "type": "string", "nullable": true }, "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string" }, "isSelectStepOnDeny": { "type": "string" }, "type": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "reason": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "isUserApprover": { "type": "string" }, "userGroupNames": { "type": "array", "nullable": true, "items": {} }, "type": { "type": "string" }, "minApprovalsForGroups": { "type": "array", "nullable": true, "items": {} }, "isPostStepLogicFailed": { "type": "boolean", "nullable": true }, "postStepLogicName": { "type": "string" }, "id": { "type": "string" }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "string" } }, "userGroupTypedId": { "type": "string", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "items": { "type": "object", "properties": { "approver": { "type": "string" }, "approverLoginName": { "type": "string" }, "approverTypedId": { "type": "string" }, "executionStatus": { "type": "string", "nullable": true }, "lastExecutedBy": { "type": "string", "nullable": true }, "lastExecutedByName": { "type": "string" }, "approvedCount": { "type": "integer" }, "minApprovalsNeeded": { "type": "integer" }, "reason": { "type": "string" }, "comment": { "type": "string", "nullable": true }, "comments": { "type": "object", "nullable": true }, "lastExecutionDate": { "type": "string", "format": "date", "nullable": true } } } }, "executionStatus": { "type": "string" }, "userTypedIds": { "type": "array", "items": { "type": "string" } }, "lastAccess": { "type": "string" }, "minApprovalsNeeded": { "type": "integer" }, "userName": { "type": "string" }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": { "type": "array", "nullable": true, "items": {} }, "userTypedId": { "type": "string" }, "uniqueName": { "type": "string" }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": { "type": "string", "nullable": true }, "isDenialReasonOptional": { "type": "string" }, "userNames": { "type": "array", "items": { "type": "string" } }, "comment": { "type": "string", "nullable": true }, "mandatoryComments": { "type": "object", "nullable": true } } } }, "approvableTypedId": { "type": "string" }, "currentStepId": { "type": "string" }, "submitReason": { "type": "string", "nullable": true }, "submitterUserName": { "type": "string", "nullable": true }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "nullable": true }, "isDenialReasonOptional": { "type": "string" }, "id": { "type": "string" }, "isAddStepRestrictedToWFAdmin": { "type": "string" } } }, "resultType": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6c45d969f6-2fb9b", "data": [ { "layout": null, "workflow": { "workflowStatus": "DRAFT", "isSelectStepOnDeny": "false", "type": "customform", "steps": [ { "reason": "Please approve this CFO. After approval, go to MD > P > B-0002 and attribute1 field should be updated", "reasons": [ "Please approve this CFO. After approval, go to MD > P > B-0002 and attribute1 field should be updated" ], "isUserApprover": "true", "userGroupNames": null, "type": "ApprovalWorkflowStep", "minApprovalsForGroups": null, "isPostStepLogicFailed": null, "postStepLogicName": "CFO_Post_Step_WF", "id": "8fc479cd-a935-4ca7-81c7-dd36bf9b2b05", "executedByNames": [], "userLoginNames": [ "john.doe" ], "userGroupTypedId": null, "approvalRequiredEmailAttachments": [], "subSteps": [ { "approver": "John Doe", "approverLoginName": "john.doe", "approverTypedId": "2147483667.U", "executionStatus": null, "lastExecutedBy": null, "lastExecutedByName": "", "approvedCount": 0, "minApprovalsNeeded": 1, "reason": "Please approve this CFO. After approval, go to MD > P > B-0002 and attribute1 field should be updated", "comment": null, "comments": null, "lastExecutionDate": null } ], "executionStatus": "INITIALIZED", "userTypedIds": [ "2147483667.U" ], "lastAccess": "2023-10-04T10:45:51", "minApprovalsNeeded": 1, "userName": "John Doe", "delegatedToTypedIds": [], "userGroupTypedIds": null, "userTypedId": "2147483667.U", "uniqueName": "PostStepWorkflow", "denialReasons": [], "userGroupName": null, "isDenialReasonOptional": "true", "userNames": [ "John Doe" ], "comment": null, "mandatoryComments": null } ], "approvableTypedId": "352.CFO", "currentStepId": "8fc479cd-a935-4ca7-81c7-dd36bf9b2b05", "submitReason": null, "submitterUserName": null, "denialReasons": [], "submitterTypedId": null, "isDenialReasonOptional": "true", "id": "82ffbe04-f03e-4c91-bb86-d011cb350841", "isAddStepRestrictedToWFAdmin": "false" }, "resultType": "WORKFLOW" } ], "status": 0 } } } } } } } }, "tags": [ "Custom Forms" ], "description": "Retrieves workflow details for the Custom Form where workflowStatus=`DRAFT`.

\n**Avaialble for the following roles**:\n- `SUPPORT` (*Investigate for Support*)\n- `CUSTOM_FORM_RO` (*View Custom Form*)", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/rebaterecordgroup.submit/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Rebate Record Group you want to submit." } ], "post": { "summary": "Submit a Rebate Record Group", "operationId": "post-rebaterecordgroup.submit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "submitRebateRecordGroup", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordGroup" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-745cd4d685-67rjj", "data": [ { "version": 49, "typedId": "19.RRG", "label": "GROUP1", "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "agreementStatus": "APPROVED", "uniqueName": "RRG-19", "sourceId": "R-2147483892", "sourceIdNoRev": "R-2147483892", "name": "GROUP1", "status": "SUBMITTED", "startDate": "2023-12-06", "endDate": "2023-12-06", "payoutDate": "2023-12-06", "targetDate": null, "formulaName": "RRG_CalcLogic", "calculationStatus": 6, "lastUpdateByName": null, "createdByName": null, "submittedByName": "ondrej.tesar", "approvalState": "NOT_APPROVED", "workflowStatus": "SUBMITTED", "userGroupEdit": null, "userGroupViewDetails": null, "serverMessagesExtended": [ { "key": "RED_ALERT", "message": "The average is less than 20.", "source": "ITEMS" }, { "key": "RRG_CALCULATED", "message": "Rebate record group calculated successfully", "source": "ITEMS" }, { "key": "RRG_SUBMITTED", "message": "Rebate record group submitted", "source": "ITEMS" } ], "locked": false, "calculatedMsg": "RRG_CALCULATED", "calculatedWithErrorsMsg": "RRG_CALCULATED_WITHERRORS", "submittedMsg": "RRG_SUBMITTED", "ongoingCalculationMsg": "RRG_ONGOING_CALCULATION", "parentTypedId": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "createDate": "2023-12-06T09:06:54", "createdBy": 2147492363, "lastUpdateDate": "2023-12-06T09:11:59", "lastUpdateBy": 2147490187, "attribute1": "10", "attribute2": "15", "attribute3": "2021-09-01", "attribute4": "15", "attribute5": "2021-09-29", "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": "Attribute100String", "headerRebateType": "RRG_RBA", "approvalDate": null, "calculationDate": "2023-12-06T09:11:59", "rebateType": "Create_RRG", "completeResultsAvailable": true, "itemExtensions": {}, "attributeExtension___AttributeExtensionColumn": "test" } ], "status": 0 } } } } } } } }, "tags": [ "Rebate Record Group" ], "description": "Submits a Rebate Record Group.

\nUse the `/rebaterecordgroup.submit/{typedId}/async` endpoint to perform the submit action asynchronously.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/rebaterecordgroup.calculate/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.RRG" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Rebate Record Group you want to calculate." } ], "post": { "summary": "Calculate a Rebate Record Group", "operationId": "post-rebaterecordgroup.calculate-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "title": "calculateRebateRecordGroupResponse", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordGroup" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7b4969966c-kqmvr", "data": [ { "version": 26, "typedId": "1.RRG", "label": "GROUP1", "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "agreementStatus": "DRAFT", "uniqueName": "RRG-1", "sourceId": "R-2147483885", "sourceIdNoRev": "R-2147483885", "name": "GROUP1", "status": "DRAFT", "startDate": "2023-11-24", "endDate": "2023-11-24", "payoutDate": "2023-11-24", "targetDate": "2023-11-24", "inputs": [], "formulaName": "RRG_CalcLogic", "calculationStatus": 4, "lastUpdateByName": null, "createdByName": null, "submittedByName": null, "approvalState": "NOT_APPROVED", "workflowStatus": "DRAFT", "userGroupEdit": null, "userGroupViewDetails": null, "serverMessagesExtended": [ { "key": "RED_ALERT", "message": "The average is less than 20.", "source": "ITEMS" }, { "key": "RRG_CALCULATED", "message": "Rebate record group calculated successfully", "source": "ITEMS" } ], "locked": false, "approvedByName": null, "deniedByName": null, "parentTypedId": null, "approvalRequiredEmailAttachments": null, "calculatedMsg": "RRG_CALCULATED", "submittedMsg": "RRG_SUBMITTED", "ongoingCalculationMsg": "RRG_ONGOING_CALCULATION", "calculatedWithErrorsMsg": "RRG_CALCULATED_WITHERRORS", "hasWorkflowHistory": false, "createDate": "2023-11-24T12:12:17", "createdBy": 2147483667, "lastUpdateDate": "2023-11-28T12:19:16", "lastUpdateBy": 2147490187, "attribute1": "10", "attribute2": "15", "attribute3": "2021-09-01", "attribute4": "15", "attribute5": "2021-09-29", "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": "Attribute100String", "headerRebateType": "RRG_RBA", "approvalDate": null, "calculationDate": "2023-11-28T12:19:15", "rebateType": "Create_RRG", "calculationResults": [ { "resultName": "sum", "resultLabel": "Pyout Sum", "result": 15, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "average", "resultLabel": "Average Payout per condition", "result": 10, "excludeFromExport": false, "warnings": null, "alertMessage": "The average is less than 20.", "alertType": "RED", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "median", "resultLabel": "Median Payout", "result": 15, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "getStartDate", "resultLabel": "Payout Period Start Date", "result": "2021-09-01", "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "DATE", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "getEndDate", "resultLabel": "PayoutPeriod End Date", "result": "2021-09-29", "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "DATE", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "attribute100", "resultLabel": "attribute 100", "result": "Attribute100String", "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "TEXT", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null }, { "resultName": "input", "resultLabel": "Breakdown", "result": { "dragDropEnabled": true, "resizingEnabled": true, "inputs": [ { "name": "Price", "label": "Price", "type": "INPUTMATRIX", "typedId": "1.RRG", "inputs": [], "parameterConfig": { "columns": [ "Scale Qty", "Freight Cost", "Price" ] }, "formattingOptions": {} } ], "firstInput": { "name": "Price", "label": "Price", "type": "INPUTMATRIX", "typedId": "1.RRG", "inputs": [], "parameterConfig": { "columns": [ "Scale Qty", "Freight Cost", "Price" ] }, "formattingOptions": {} }, "resultType": "CONFIGURATORENTRY" }, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "TEXT", "suffix": null, "resultType": "CONFIGURATORENTRY", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridden": false, "overridable": false, "resultDescription": null } ], "completeResultsAvailable": true, "itemExtensions": {} } ], "status": 0 } } } } } } }, "400": { "description": "Bad Request. No RebateRecordGroup specified." }, "404": { "description": "Rebate Record Group not found." } }, "description": "Calculates the specified Rebate Record Group (RRG).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "rebateRecordGroup": { "$ref": "#/components/schemas/RebateRecordGroup" } } } } } } } }, "tags": [ "Rebate Record Group" ] } }, "/fetch/RRG": { "post": { "summary": "Get a Rebate Record Group", "operationId": "post-fetch-RRG", "responses": { "200": { "description": "OK" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "getRRGRequestExample": { "value": { "operationType": "fetch", "textMatchStyle": "exact", "data": { "fieldName": "uniqueName", "operator": "equals", "value": "RRG-7", "_constructor": "AdvancedCriteria" }, "oldValues": null } } } } } }, "tags": [ "Rebate Record Group" ], "description": "Retrieves the Rebate Record Group specified by the filter in the request payload. Retrieves all Rebate Record Groups when the payload is empty." } }, "/rebaterecordgroup.revoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Rebate Record Group you want to revoke." } ], "post": { "summary": "Revoke a Rebate Record Group", "operationId": "post-rebaterecordgroup.revoke-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RebateRecordGroup" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7fcbb9d98-lhpwp", "data": [ { "version": 38, "typedId": "37.RRG", "label": "R-2147483896_2023-12-06", "comments": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "agreementStatus": "APPROVED", "uniqueName": "RRG-37", "sourceId": "R-2147483896", "sourceIdNoRev": "R-2147483896", "name": "R-2147483896_2023-12-06", "status": "REVOKED", "startDate": "2023-12-06", "endDate": "2023-12-06", "payoutDate": "2023-12-06", "targetDate": null, "inputs": null, "formulaName": "RRG_CalcLogic", "calculationStatus": 2, "lastUpdateByName": null, "createdByName": null, "submittedByName": "ondrej.tesar", "approvalState": "APPROVED", "workflowStatus": "APPROVED", "userGroupEdit": null, "userGroupViewDetails": null, "serverMessagesExtended": null, "locked": false, "calculatedMsg": "RRG_CALCULATED", "calculatedWithErrorsMsg": "RRG_CALCULATED_WITHERRORS", "submittedMsg": "RRG_SUBMITTED", "ongoingCalculationMsg": "RRG_ONGOING_CALCULATION", "hasWorkflowHistory": true, "parentTypedId": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "createDate": "2023-12-06T09:33:37", "createdBy": 2147492363, "lastUpdateDate": "2023-12-06T10:25:37", "lastUpdateBy": 2147490187, "attribute1": "66", "attribute2": "190", "attribute3": "2021-09-01", "attribute4": "95", "attribute5": "2021-09-29", "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "headerRebateType": "RRG_RBA", "approvalDate": "2023-12-06T10:25:26", "calculationDate": "2023-12-06T10:25:15", "rebateType": "Create_RRG", "calculationResults": [ { "resultName": "sum", "resultLabel": "Pyout Sum", "result": 190, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "average", "resultLabel": "Average Payout per condition", "result": 66, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "median", "resultLabel": "Median Payout", "result": 95, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "MONEY_EUR", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "getStartDate", "resultLabel": "Payout Period Start Date", "result": "2021-09-01", "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "DATE", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "getEndDate", "resultLabel": "PayoutPeriod End Date", "result": "2021-09-29", "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "DATE", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "attribute100", "resultLabel": "attribute 100", "result": null, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "TEXT", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "input", "resultLabel": "Test String Input Output", "result": null, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "TEXT", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "optionsInput", "resultLabel": "optionsInput", "result": null, "excludeFromExport": false, "warnings": [ "Option-Entry parameter not found" ], "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "TEXT", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "DateTimeUserEntry", "resultLabel": "DateTimeUsertEntry", "result": null, "excludeFromExport": false, "warnings": [ "UserEntry parameter not found: DateTime User Entry" ], "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "DATETIME", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null }, { "resultName": "BooleanInput", "resultLabel": "BooleanInput", "result": null, "excludeFromExport": false, "warnings": [ "UserEntry parameter not found: Boolean Entry" ], "alertMessage": null, "alertType": "YELLOW", "displayOptions": 16, "formatType": "NUMERIC", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "completeResultsAvailable": true, "itemExtensions": {}, "attributeExtension___AttributeExtensionColumn": "test" } ], "status": 0 } } } } } } } }, "tags": [ "Rebate Record Group" ], "description": "Revokes a Rebate Record Group." } }, "/rebaterecordgroup.masssubmit/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Mass Submit Rebate Record Groups", "operationId": "post-rebaterecordgroup.masssubmit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "massSubmitRRGResponse", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6655f7984c-nxlx2", "data": [ { "version": 0, "typedId": "2148047737.JST", "processingNode": null, "threadId": null, "threadUUID": null, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "status": "WAITING_FOR_DISPATCH", "trackerType": "RRG_SUBMIT", "targetObject": "RRG", "jobName": "RRG", "concurrencyKey": "RRG", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "jobType": "RRG_SUBMIT", "uuid": "pC077", "calculableObjectTypedId": "RRG", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3761623964", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "hasWarning": false, "createDate": "2023-12-06T12:11:28", "createdBy": 2147490187, "lastUpdateDate": "2023-12-06T12:11:28", "lastUpdateBy": 2147490187, "parameters": "{\"typedIds\":[\"38.RRG\",\"39.RRG\"]}", "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148047737 } ], "status": 0 } } } } } } } }, "tags": [ "Rebate Record Group" ], "description": "Performs the mass submit action on Rebate Record Groups specified by the filter in the request body.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } }, "_constructor": { "type": "string" } } } } } } }, "examples": { "massSubmitRRGRequestExample": { "value": { "data": { "filterCriteria": { "fieldName": "uniqueName", "operator": "inSet", "value": [ "RRG-38", "RRG-39" ], "_constructor": "AdvancedCriteria" } } } } } } } } } }, "/rebaterecordgroup.preview/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Preview a Rebate Record Group Workflow", "operationId": "post-rebaterecordgroup.preview-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "layout": { "type": "object", "nullable": true }, "dragDropEnabled": { "type": "boolean" }, "resizingEnabled": { "type": "boolean" }, "workflow": { "type": "object", "properties": { "workflowStatus": { "type": "string" }, "isSelectStepOnDeny": { "type": "string" }, "type": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "properties": { "reason": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "isUserApprover": { "type": "string" }, "userGroupNames": { "type": "array", "nullable": true, "items": {} }, "type": { "type": "string" }, "minApprovalsForGroups": { "type": "string", "nullable": true }, "isPostStepLogicFailed": { "type": "string", "nullable": true }, "postStepLogicName": { "type": "string", "nullable": true }, "id": { "type": "string" }, "executedByNames": { "type": "array", "items": { "type": "object" } }, "userLoginNames": { "type": "array", "items": { "type": "string" } }, "userGroupTypedId": { "type": "string", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object" } }, "subSteps": { "type": "array", "items": { "type": "object", "properties": { "approver": { "type": "string" }, "approverLoginName": { "type": "string" }, "approverTypedId": { "type": "string" }, "executionStatus": { "type": "string", "nullable": true }, "lastExecutedBy": { "type": "string", "nullable": true }, "lastExecutedByName": { "type": "string" }, "approvedCount": { "type": "integer" }, "minApprovalsNeeded": { "type": "integer" }, "reason": { "type": "string" }, "comment": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "lastExecutionDate": { "type": "string", "nullable": true } } } }, "executionStatus": { "type": "string" }, "userTypedIds": { "type": "array", "items": { "type": "string" } }, "lastAccess": { "type": "string" }, "minApprovalsNeeded": { "type": "integer" }, "userName": { "type": "string" }, "delegatedToTypedIds": { "type": "array", "items": { "type": "object" } }, "userGroupTypedIds": { "type": "string", "nullable": true }, "userTypedId": { "type": "string" }, "uniqueName": { "type": "string" }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "userGroupName": { "type": "string", "nullable": true }, "isDenialReasonOptional": { "type": "string" }, "userNames": { "type": "array", "items": { "type": "string" } }, "comment": { "type": "string", "nullable": true }, "mandatoryComments": { "type": "string", "nullable": true } } } }, "approvableTypedId": { "type": "string" }, "currentStepId": { "type": "string" }, "submitReason": { "type": "string", "nullable": true }, "submitterUserName": { "type": "string", "nullable": true }, "denialReasons": { "type": "array", "items": { "type": "object" } }, "submitterTypedId": { "type": "string", "nullable": true }, "isDenialReasonOptional": { "type": "string" }, "id": { "type": "string" }, "isAddStepRestrictedToWFAdmin": { "type": "string" } } }, "resultType": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": {} } } } }, "tags": [ "Rebate Record Group" ], "description": "Returns a Rebate Record Group workflow preview (resultWorkflow DTO).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "rebateRecordGroup": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "label": { "type": "string" }, "agreementStatus": { "type": "string" }, "uniqueName": { "type": "string" }, "sourceId": { "type": "string" }, "sourceIdNoRev": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "payoutDate": { "type": "string" }, "calculationStatus": { "type": "integer" }, "locked": { "type": "boolean" }, "calculatedMsg": { "type": "string" }, "calculatedWithErrorsMsg": { "type": "string" }, "submittedMsg": { "type": "string" }, "ongoingCalculationMsg": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "headerRebateType": { "type": "string" }, "rebateType": { "type": "string" }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": {} } }, "completeResultsAvailable": { "type": "boolean" }, "itemExtensions": { "type": "object", "properties": {} } } } } } } } } } } } }, "/fetch/CPR": { "post": { "summary": "List Contract Price Records", "operationId": "post-fetch-CPR", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "title": "listContractPriceRecords", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContractPriceRecord" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6d6b77f6d9-z68h2", "startRow": 0, "data": [ { "version": 1, "typedId": "2.CPR", "uniqueName": "CPR-2", "status": "ACTIVE", "sourceId": "C-16", "lineId": "xrb3OqEZ66m3VXL", "priority": 0, "validAfter": "2018-04-04", "expiryDate": "2019-01-01", "externalRef": "", "label": "newlyGeneratedRecord", "createDate": "2023-11-07T08:12:35", "createdBy": 2147490698, "lastUpdateDate": "2023-11-07T08:12:35", "lastUpdateBy": 2147490698, "attribute1": "newlyGeneratedPR", "sourceIdNoRev": "C-16" }, { "version": 1, "typedId": "3.CPR", "uniqueName": "CPR-3", "status": "ACTIVE", "sourceId": "C-16", "lineId": "TXtzimqBsvAaK8R", "priority": 0, "validAfter": "2018-04-04", "expiryDate": "2019-01-01", "externalRef": "", "label": "newlyGeneratedRecord", "createDate": "2023-11-07T08:12:35", "createdBy": 2147490698, "lastUpdateDate": "2023-11-07T08:12:35", "lastUpdateBy": 2147490698, "attribute1": "newlyGeneratedPR", "sourceIdNoRev": "C-16" } ], "endRow": 8, "totalRows": 8, "status": 0 } } } } } } } }, "tags": [ "Contracts (Agreements & Promotions)" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "_constructor": { "type": "string" } } } }, "operator": { "type": "string" } } } } }, "examples": { "Example 1": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "criteria": [ { "fieldName": "sourceId", "operator": "notStartsWith", "value": "P-", "_constructor": "AdvancedCriteria" } ], "operator": "and" } } } } } } }, "description": "Retrieves Contract Price Records (CPR). Use the filter (see the request sample) to exclude Quote Price Records from the returned Price Records.\n>To work with Contract Price Records, the option `enableAPRecalculation` must be set to true. Navigate to **Administration** > **Configuration** > **System Configuration** > **Advanced Configuration Options** and add the `enableAPRecalculation` option.\n" } }, "/fetch/CTC": { "post": { "summary": "List Contract Calculations", "operationId": "post-fetch-CTC", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContractCalculation" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-687494b664-mgwpf", "startRow": 0, "data": [ { "version": 4, "typedId": "1.CTC", "label": "Test_Calc", "calculationMessages": "[\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\",\"Agreement & Promotion calculated successfully\"]", "calculationConfig": { "formulaName": "Approved_contracts_recalc", "feederInputParams": [], "inputParams": [], "mappingParams": [], "outputElements": [] }, "createDate": "2023-11-07T08:11:45", "createdBy": 2147490698, "lastUpdateDate": "2023-11-07T08:12:35", "lastUpdateBy": 2147490698, "status": "READY", "calculationStartDate": "2023-11-07T08:12:35", "calculationDate": "2023-11-07T08:12:35", "isDefault": false, "shouldSubmit": false, "valid": true } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Contracts (Agreements & Promotions)" ], "description": "Retrieves Contract Calculations.\n>To work with Contract Calculations, the option `enableAPRecalculation` must be set to true. Navigate to **Administration** > **Configuration** > **System Configuration** > **Advanced Configuration Options** and add the `enableAPRecalculation` option.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/rebaterecordgroup.shouldsubmitasynchronously/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Rebate Record Group you want to return the async threshold boolean for." } ], "post": { "summary": "Should Submit a RRG Asynchronously", "operationId": "post-rebaterecordgroup.shouldsubmitasynchronously-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "boolean" } }, "status": { "type": "integer" } } } } }, "examples": { "RRGAsyncResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ false ], "status": 0 } } } } } } }, "400": { "description": "Bad Request - No RebateRecordGroup specified." }, "404": { "description": "Rebate Record Group not found" } }, "tags": [ "Rebate Record Group" ], "description": "Returns `true` if the **Submit** action of the specified Rebate Record Group should be performed asynchronmously.

\nIf the number of Rebate Records within the given Rebate Record Group exceeds a defined threshold the group should be submitted in the asynchronous way. The threshold number can be set in the **Advanced Configuration Option** key `asyncSubmitRRGThreshold`. The default value is *10*. Set to *0* to always submit a Rebate Record Group asynchronously.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/rebaterecordgroup.masssubmit": { "post": { "summary": "Mass Submit Rebate Record Groups", "operationId": "post-rebaterecordgroup.masssubmit", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusTracker" } }, "status": { "type": "integer" } } } } }, "examples": { "massSubmitRRGResponseExample": { "value": { "response": { "node": "pricefx-cluster-app-frontend-df49586c8-nkzxh", "data": [ { "version": 0, "typedId": "2148048131.JST", "processingNode": null, "threadId": null, "threadUUID": null, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "status": "WAITING_FOR_DISPATCH", "trackerType": "RRG_SUBMIT", "targetObject": "RRG", "jobName": "RRG", "concurrencyKey": "RRG", "calculationContext": null, "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "jobType": "RRG_SUBMIT", "uuid": "4m7cc", "calculableObjectTypedId": "RRG", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "3761623964", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "hasWarning": false, "lightweight": false, "createDate": "2023-12-28T12:16:17", "createdBy": 2147490187, "lastUpdateDate": "2023-12-28T12:16:17", "lastUpdateBy": 2147490187, "parameters": "{\"typedIds\":[\"17.RRG\",\"18.RRG\"]}", "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2148048131 } ], "status": 0 } } } } } } } }, "tags": [ "Rebate Record Group" ], "description": "Peforms the Mass Submit action of the Rebate Record Groups specified by the filter in the request body.

\nThe Mass Submit action is always performed asynchronously - returns Job Status Tracker (JST).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } }, "_constructor": { "type": "string" } } } } } } }, "examples": { "massSubmitRRGRequestExample": { "value": { "data": { "filterCriteria": { "fieldName": "uniqueName", "operator": "inSet", "value": [ "RRG-1", "RRG-2" ], "_constructor": "AdvancedCriteria" } } } } } } } } } }, "/accountmanager.changetermsofuse": { "post": { "summary": "Change Terms of Use", "operationId": "post-accountmanager.changetermsofuse", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request" } }, "tags": [ "Admin Tools" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "lastTermsOfUseVersionAgreed": { "type": "string" }, "lastTermsOfUseAgreedDate": { "type": "string" } } } } } }, "examples": { "Example": { "value": { "data": [ { "lastTermsOfUseVersionAgreed": "12.0", "lastTermsOfUseAgreedDate": "2023-12-28T15:00:00" } ] } } } } } }, "deprecated": true } }, "/clicmanager.create/{TypeCode}": { "parameters": [ { "schema": { "type": "string", "enum": [ "Q", "QTMP" ], "example": "Q" }, "name": "TypeCode", "in": "path", "required": true, "description": "Enter the type code of the entity you want to create." } ], "post": { "summary": "Create a Quote", "operationId": "post-clicmanager.create-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Quotes", "Clicmanager" ], "description": "Creates a Quote (Q) or a Temporary Quote (QTMP).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "quote": { "$ref": "#/components/schemas/Quote" } } } } }, "examples": { "createQuoteRequestExample": { "value": { "data": { "quote": { "inputs": [ { "name": "Customer", "label": "Customer", "type": "CUSTOMER", "url": "/fetch/C/" } ], "outputs": [], "lineItems": [], "label": "New Quote", "quoteType": null, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "expiryDate": "2024-01-18", "targetDate": "2024-01-18", "externalRef": null, "viewState": {} } } } } } } } } } }, "/clicmanager.save/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.QTMP" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Temporary Quote you want to save." } ], "post": { "summary": "Save a Temporary Data", "operationId": "post-clicmanager.save-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "status": { "type": "integer" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "description": "Stores the temporary data from `QTMP` to the persisted data (`Q`). Returns the Quote (`Q`) object.", "tags": [ "Quotes", "Clicmanager" ] } }, "/clicmanager.fetchtmpheader/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147494304.Q" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the Quote you want to retrieve the temporary data from." } ], "post": { "summary": "Get a Temporary Data", "operationId": "post-clicmanager.fetchtmpheader-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/quoteTmp" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-bdcdc86b4-c5npl", "data": [ { "version": 3, "typedId": "12.QTMP", "uniqueName": "PT-12", "label": "New Quote", "targetDate": "2024-01-18", "workflowStatus": "DRAFT", "headerText": null, "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "CustomerGroup", "label": "Zakosi", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Produkty", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": null, "valueHint": null, "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": null, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": "DRAFT", "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "originDeleted": null, "originLabel": null, "originUniqueName": null, "signature": null, "expiryDate": "2024-01-18", "externalRef": null, "locked": false, "customerId": null, "customerName": null, "originClicId": null, "lostReason": null, "lostReasonComment": null, "customerGroup": null, "quoteStatus": "DRAFT", "persistedClicId": 2147494304, "persistedClicVersion": 3, "approvedByName": null, "deniedByName": null, "renderInfo": null, "serverMessagesExtended": null, "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2024-01-18T10:50:06", "createdBy": 2147490696, "lastUpdateDate": "2024-01-18T10:50:06", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "PT-12", "ioMeta": { "inputs": {}, "outputs": {} }, "quoteType": null, "status": "DRAFT" } ], "status": 0 } } } } } } } }, "tags": [ "Quotes", "Clicmanager" ], "description": "Retrieves the existing temporary data (`QTMP`) for the specified Quote. Creates a new `QTMP` object for the Quote, if the temporary data does not exist.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/clicmanager.removeallitems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "`typedId` of the object you want to remove all line items from." } ], "post": { "summary": "Delete All Line Items", "operationId": "post-clicmanager.removeallitems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-657c8dd448-5w72q", "data": [ { "version": 8, "typedId": "2147494437.Q", "uniqueName": "P-2147494437", "label": "New Quote", "targetDate": "2024-05-13", "workflowStatus": "DRAFT", "inputs": null, "viewState": null, "outputs": null, "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 2, "dirty": false, "refreshInputs": false, "nodeId": 0, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "3 items have been removed" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": "DRAFT", "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "originDeleted": null, "originLabel": null, "originUniqueName": null, "expiryDate": "2024-05-13", "externalRef": null, "locked": false, "customerId": null, "customerName": null, "originClicId": null, "lostReason": null, "lostReasonComment": null, "customerGroup": null, "quoteStatus": "DRAFT", "approvedByName": null, "deniedByName": null, "hasWorkflowHistory": false, "serverMessagesExtended": [ { "key": "REMOVAL", "message": "3 items have been removed", "source": "ITEMS" } ], "renderInfo": null, "approvalRequiredEmailAttachmentsJson": null, "createDate": "2024-05-13T14:05:43", "createdBy": 2147490696, "lastUpdateDate": "2024-05-13T14:06:28", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "P-2147494437", "lastCalculationDate": "2024-05-13T14:05:53", "quoteType": "default", "status": "DRAFT" }, { "": [ "W1bqKR9TMbKNMZz", "C2t0HFsJFnRn4gq", "1p2fN8CZkvTwTYh" ] } ], "status": 0 } } } } } } } }, "tags": [ "Clicmanager", "Contracts (Agreements & Promotions)", "Quotes", "Rebate Agreements", "Sales Compensations" ], "description": "Removes all line items from a specified CLIC (Quote,Agreements & Promotions (Contract), Rebate Agreement, Compensation Plan) object.

\nThis action can be performed only on doucments in the `DRAFT` status.
\n>If 'Recalculate after line item modification' option is set then the document is recalculated.\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/i18nmanager.fetchWithExtraData": { "post": { "summary": "List Internationalization Messages", "operationId": "post-i18nmanager.fetchWithExtraData", "responses": { "200": { "description": "OK - contains the messages for the locale.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "localeLanguage": { "type": "string" }, "localeData": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "overriddenValue": { "type": "string", "nullable": true } } } } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": [ { "localeLanguage": "en", "localeData": [ { "key": "QUOTE_CALCULATED", "value": "Quote calculated successfully", "overriddenValue": "Quote calculated" }, { "key": "workflow_viewHistory", "value": "View workflow history", "overriddenValue": null } ] } ], "status": 0 } } } } } } }, "403": { "description": "Forbidden - the user does not have a required permission (`I18N_FETCH`)." } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "partitionWideOverride": { "type": "boolean", "description": "Set to `true` to fetch Partition-wide messages, or `false` to fetch Private messages." } } } } }, "examples": { "Example 1": { "value": { "data": { "partitionWideOverride": true } } } } } } }, "description": "Retrieves internationalization messages. Each i18n message contains `key`, `value`, and `overriddenValue`.

\n\n**Required roles**\n- `I18NADMIN`\n- `SUPPORT`", "tags": [ "Internationalization" ] } }, "/i18nmanager.deleteKeys": { "post": { "summary": "Delete Internationalization Messages", "operationId": "post-i18nmanager.deleteKeys", "responses": { "200": { "description": "OK - the internationalization keys have been deleted successfully." }, "403": { "description": "Forbidden - the user does not have a required permission (`I18N_DELETE`)." } }, "tags": [ "Internationalization" ], "description": "Deletes the specified internationalization messages.

\n**Required roles**\n- `I18NADMIN`\n- `SUPPORT`", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messages": { "type": "array", "description": "The list of keys you want to delete.", "items": { "type": "string" } }, "partitionWideOverride": { "type": "boolean", "description": "Set to `true` to delete Partition-wide messages, or `false` to fetch Private messages." } } } } }, "examples": { "Example 1": { "value": { "data": { "messages": [ "testKey" ], "partitionWideOverride": true } } } } } } } } }, "/i18nmanager.put": { "post": { "summary": "Add a New Internationalization Message", "operationId": "post-i18nmanager.put", "responses": { "201": { "description": "Created - the new internationalization messages have been added.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "errors": { "type": "object", "properties": { "Message": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } } }, "Status": { "type": "object", "properties": { "errorMessage": { "type": "string" } } }, "HTTPCode": { "type": "object", "properties": { "errorMessage": { "type": "string" } } }, "Action": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } } }, "Timestamp": { "type": "object", "properties": { "errorMessage": { "type": "string", "nullable": true } } } } }, "status": { "type": "integer" } } } } } } } }, "403": { "description": "Forbidden - the user does not have a required permission (`I18N_UPDATE`)." } }, "tags": [ "Internationalization" ], "description": "Adds overridden internationalization messages to the existing collection.

\n**Required roles**\n- `I18NADMIN`\n- `SUPPORT`", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messages": { "type": "object", "properties": { "testKey": { "type": "string" } } }, "partitionWideOverride": { "type": "boolean", "description": "Set to `true` to add messages Partition-wide, or `false` to add Private messages." } } } } }, "examples": { "Example 1": { "value": { "data": { "messages": { "testKey": "testValue" }, "partitionWideOverride": true } } } } } }, "description": "" } } }, "/clicmanager.importlineitems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Import Line Items (w/o Input Types)", "operationId": "post-clicmanager.importlineitems-typedId", "responses": { "200": { "description": "OK - `ServerMessageExtended` property contains information about what was imported", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-79df676dd9-lr6pk", "data": [ { "outputs": [], "lastUpdateByName": "john.doe", "createdByName": "john.doe", "typedId": "2147494406.Q", "workflowStatus": "DRAFT", "inputs": [ { "name": "Customer", "label": "Customer", "url": "/fetch/C/", "type": "CUSTOMER", "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "lastUpdateDate": "2024-06-17T08:37:58", "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully", "source": "HEADER" }, { "key": "IMPORT", "message": "Lake Street Express has been imported", "source": "ITEMS" } ], "quoteStatus": "DRAFT", "expiryDate": "2024-07-18", "locked": false, "lastCalculationDate": "2024-06-17T08:37:58", "createDate": "2024-06-17T08:37:36", "dirty": false, "refreshInputs": false, "rootUniqueName": "P-2147494406", "numberOfAttachments": 0, "targetDate": "2024-06-17", "ioMeta": { "inputs": { "Quantity": { "name": "Quantity", "label": "Quantity", "type": "INTEGERUSERENTRY", "required": true, "typedId": "2147494406.Q", "inputs": [], "parameterConfig": { "dataType": "integer" }, "formattingOptions": {} } }, "outputs": { "RequiredInput": { "resultName": "RequiredInput", "resultLabel": "RequiredInput", "excludeFromExport": false, "displayOptions": 16, "resultType": "SIMPLE", "overrideAllowEmpty": true, "overridden": false, "overridable": false } } }, "label": "New Quote", "version": 10, "uniqueName": "P-2147494406", "serverMessages": [ "Quote calculated successfully" ], "createdBy": 2147492363, "viewState": {}, "calculationStatus": 2, "hasWorkflowHistory": false, "nodeId": 0, "lastUpdateBy": 2147492363, "status": "DRAFT" }, { "folderChanged": false, "inputChanged": [], "outputChanged": [], "durations": { "header": [ { "name": "pre", "duration": 13 }, { "name": "post", "duration": 8 } ], "items": [ { "name": "B-0007", "duration": 5 } ] }, "changedItems": [] }, { "addedLineIds": [ "rmguufbOhjxSPS9" ] } ], "status": 0 } } } } } } } }, "tags": [ "Clicmanager", "Contracts (Agreements & Promotions)", "Quotes", "Rebate Agreements", "Sales Compensations" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "parent": { "type": "string" }, "skus": { "type": "array", "items": { "type": "object", "properties": { "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "label": { "type": "string" }, "sku": { "type": "string" }, "folder": { "type": "boolean" } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "parent": "ROOT", "skus": [ { "inputs": [ { "name": "Integer Input", "value": "123" } ], "label": "TEST", "sku": "B-0006", "folder": false } ] } } } } } } }, "description": "Imports CLIC line items without specified input types, alowing to assign the input type to the line item using logic.\n

The input name of the imported line item in the API request is compared with the name of inputs generated by the line item logic. If those names are equal, the input type from the calculation logic is used." } }, "/conditionrecordset.update/{id}": { "parameters": [ { "schema": { "type": "string" }, "name": "id", "in": "path", "required": true, "description": "`id` of the ConditionRecordSet object you want to update." } ], "post": { "summary": "Update a Condition Record Set", "operationId": "post-conditionrecordset.update-id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordSet" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "node", "data": [ { "version": 4, "typedId": "1.CRCS", "uniqueName": "testJH_RECSx4", "label": "Net Price", "userGroupViewDetails": "group1", "userGroupEdit": null, "keySize": 4, "createdByName": "john.doe", "lastUpdateByName": "john.doe", "updatedBy": 2147484788, "updateDate": "2024-02-27T14:53:56", "createDate": "2024-02-27T14:52:56", "createdBy": 2147484788, "lastUpdateDate": "2024-02-27T15:03:01", "lastUpdateBy": 2147484788, "id": 1 } ], "status": 0 } } } } } } } }, "description": "Allows you to update `label`, `userGroupViewDetails`, or `userGroupEdit` property of the Condition Record Set (CRCS).

\n**Required roles**:\n- `SUPPORT`\n- `PB_CONDITIONRECORDEDITOR`", "tags": [ "Condition Records" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "data": { "label": "Net Price" }, "oldValues": { "version": 3 } } } } } } } } }, "/add/CRCS": { "post": { "summary": "Add a Condition Record Set", "operationId": "post-add-CRCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordSet" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-67f5dcb4f4-pjksw", "data": [ { "version": 0, "typedId": "8.CRCS", "uniqueName": "ConditionRecordSet01", "label": "Condition Record Set 1", "userGroupViewDetails": null, "userGroupEdit": null, "keySize": 12, "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 2147490696, "updateDate": "2024-07-17T13:09:58", "createDate": "2024-06-17T13:08:58", "createdBy": 2147490696, "lastUpdateDate": "2024-06-17T13:08:58", "lastUpdateBy": 2147490696, "id": 8 } ], "status": 0 } } } } } } } }, "tags": [ "Condition Records" ], "description": "Adds a Condition Record Set (CRCS) object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string", "description": "A unique identifier." }, "label": { "type": "string" }, "keySize": { "type": "integer", "description": "The number of key fields (key1..key12). Cannot be changed once the Condition Record Set is created." } }, "required": [ "uniqueName", "keySize" ] }, "operation": { "type": "string" } } }, "examples": { "Example 1": { "value": { "data": { "uniqueName": "ConditionRecordSet01", "label": "Condition Record Set 1", "keySize": 12 }, "operation": "add" } } } } } } } }, "/fetch/CRCS": { "post": { "summary": "List Condition Record Sets", "operationId": "post-fetch-CRCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordSet" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-67f5dcb4f4-pjksw", "startRow": 0, "data": [ { "version": 0, "typedId": "8.CRCS", "uniqueName": "ConditionRecordSet01", "label": "Condition Record Set 1", "keySize": 12, "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 2147490696, "updateDate": "2024-07-17T13:08:58", "createDate": "2024-06-17T13:08:58", "createdBy": 2147490696, "lastUpdateDate": "2024-06-17T13:08:58", "lastUpdateBy": 2147490696, "id": 8 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Condition Records" ], "description": "Retrieves all Condition Record Set (CRCS) objects.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/delete/CRCS": { "post": { "summary": "Delete a Condition Records Set", "operationId": "post-delete-CRCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordSet" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-67f5dcb4f4-pjksw", "data": [ { "version": 0, "typedId": "8.CRCS", "uniqueName": "ConditionRecordSet01", "label": "Condition Record Set 1", "userGroupViewDetails": null, "userGroupEdit": null, "keySize": 12, "createdByName": "admin", "lastUpdateByName": "admin", "updatedBy": 2147490696, "updateDate": "2024-07-17T13:08:58", "createDate": "2024-06-17T13:08:58", "createdBy": 2147490696, "lastUpdateDate": "2024-06-17T13:31:35", "lastUpdateBy": 2147490696, "id": 8 } ], "status": 0 } } } } } } } }, "tags": [ "Condition Records" ], "description": "Deletes the specified Condition Record Set (CRCS).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } } } } }, "examples": { "Example 1": { "value": { "data": { "typedId": "8.CRCS" } } } } } } } } }, "/fetch/CRCI12": { "post": { "summary": "Get a Condition Record Item", "operationId": "post-fetch-CRCI12", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordItem12Key" } }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-7b7fdd5759-6h6mr", "data": [ { "version": 0, "typedId": "3.CRCI12", "conditionRecordSetId": 7, "validTo": "2025-02-01T14:10:00", "validFrom": "2024-02-01T14:10:00", "integrationStatus": 0, "createDate": "2024-06-19T10:45:40", "createdBy": 2147490696, "lastUpdateDate": "2024-06-19T10:45:40", "lastUpdateBy": 2147490696, "key1": "k", "key2": "l", "key3": "m", "key4": "n", "key5": "o", "key6": "p", "key7": "q", "key8": "r", "key9": "s", "key10": "t", "key11": "u", "key12": "v" } ], "endRow": 1 } } } } } } } }, "description": "Retrieves a Condition Record Item with 12 keys.\n\n>You can use the `CRCI1`..`CRCI12` type codes in the path to retrieve Condition Record Items with different number of keys.\n\n> It is not possible to edit or delete the `CRCI` type codes.", "tags": [ "Condition Records" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/add/CRCIM": { "post": { "summary": "Add a Condition Record Item Attribute Meta", "operationId": "post-add-CRCIM", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordItemAttributeMeta" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-54764b46f4-s7h4l", "data": [ { "version": 0, "typedId": "14.CRCIM", "fieldName": "attribute5", "label": "Attribute 5", "fieldType": 1, "formatType": "INTEGER", "fieldValueOptions": null, "cssProperties": "", "description": "", "requiredField": false, "readOnly": false, "entityRefTypeCode": null, "labelTranslations": "{\"\":\"My Super Att 5\"}", "elementName": null, "userGroup": null, "conditionRecordSetId": 7, "hidden": false, "manual": false, "inputAttribute": false, "createDate": "2024-06-19T11:53:53", "createdBy": 2147490696, "lastUpdateDate": "2024-06-19T11:53:53", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "conditionRecordSetId": { "type": "string" }, "hidden": { "type": "string" }, "fieldName": { "type": "string" }, "label": { "type": "string" }, "cssProperties": { "type": "string" }, "description": { "type": "string" }, "entityRefTypeCode": { "type": "string", "nullable": true }, "fieldType": { "type": "integer" }, "fieldValueOptions": { "type": "string", "nullable": true }, "formatType": { "type": "string" }, "labelTranslations": { "type": "string" }, "readOnly": { "type": "boolean" } } } } }, "examples": { "Example 1": { "value": { "data": { "conditionRecordSetId": "7", "hidden": "false", "fieldName": "attribute5", "label": "Attribute 5", "cssProperties": "", "description": "", "entityRefTypeCode": null, "fieldType": 1, "fieldValueOptions": null, "formatType": "INTEGER", "labelTranslations": "{\"\":\"My Super Att 5\"}", "readOnly": false } } } } } } }, "tags": [ "Condition Records" ], "description": "Creates a Condition Record Item Attribute Meta." } }, "/update/CRCIM": { "post": { "summary": "Update a Condition Record Item Attribute Meta", "operationId": "post-update-CRCIM", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompensationCondTypeAttributeMeta" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7599bbd56-75vcd", "data": [ { "version": 1, "typedId": "14.CRCIM", "fieldName": "attribute5", "label": "Attribute 4_updated", "fieldType": 2, "formatType": "TEXT", "fieldValueOptions": null, "cssProperties": "", "description": "", "requiredField": false, "readOnly": false, "entityRefTypeCode": null, "labelTranslations": "{\"\":\"My Super Att 5\"}", "elementName": null, "userGroup": null, "conditionRecordSetId": 7, "hidden": false, "manual": false, "inputAttribute": false, "createDate": "2024-06-19T11:53:53", "createdBy": 2147490696, "lastUpdateDate": "2024-06-19T12:03:33", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "label": { "type": "string" }, "fieldType": { "type": "integer" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" } } }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" } } } } }, "description": "" }, "description": "Updates a Condition Record Item Attribute Meta.", "tags": [ "Condition Records" ] } }, "/fetch/CRCIM": { "post": { "summary": "Get a Condition Record Item Attribute Meta", "operationId": "post-fetch-CRCIM", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordItemAttributeMeta" } }, "endRow": { "type": "integer" } } } } } } } } }, "description": "Retrieves a Condition Record Item Attribute Meta.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "conditionRecordSetId": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "data": { "conditionRecordSetId": 7 } } } } } } }, "tags": [ "Condition Records" ] } }, "/delete/CRCIM": { "post": { "summary": "Delete a Condition Record Item Attribute Meta", "operationId": "post-delete-CRCIM", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordItemAttributeMeta" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7599bbd56-75vcd", "data": [ { "version": 1, "typedId": "12.CRCIM", "fieldName": "key1", "label": "Key 1", "fieldType": 2, "formatType": "TEXT", "fieldValueOptions": null, "cssProperties": null, "description": null, "requiredField": false, "readOnly": false, "entityRefTypeCode": "", "labelTranslations": "{\"\":\"testKey One\"}", "elementName": null, "userGroup": null, "conditionRecordSetId": 7, "hidden": false, "manual": false, "inputAttribute": false, "createDate": "2024-06-19T10:37:41", "createdBy": 2147490696, "lastUpdateDate": "2024-06-19T12:38:21", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } } }, "operationType": { "type": "string" } } }, "examples": { "Example 1": { "value": { "data": { "typedId": "12.CRCIM" }, "operationType": "remove" } } } } } }, "tags": [ "Condition Records" ], "description": "Deletes a Condition Record Item Attribute Meta." } }, "/add/JCS": { "post": { "summary": "Add a Configuration Storage", "operationId": "post-add-JCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JsonConfigurationStorage" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6b88584c79-dd656", "data": [ { "version": 0, "typedId": "6.JCS", "name": "NewStrategy", "label": "NewStrategy", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "storageStatus": "DRAFT", "storageType": "STRATEGY", "supersededBy": null, "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"inputs\":{\"PRICE\":{\"shadow\":{\"type\":\"math_number\",\"fields\":{\"NUM\":0}}}},\"id\":\"root\"}]},\"variables\":[]}", "updateDate": "2024-07-20T09:33:20", "createDate": "2024-06-20T09:55:20", "createdBy": 2147490187, "lastUpdateDate": "2024-06-20T09:55:20", "lastUpdateBy": 2147490187, "id": 6 } ], "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "$ref": "#/components/schemas/JsonConfigurationStorage" } } }, "examples": { "Example 1": { "value": { "operationType": "add", "textMatchStyle": "exact", "data": { "name": "NewStrategy", "label": "NewStrategy", "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"inputs\":{\"PRICE\":{\"shadow\":{\"type\":\"math_number\",\"fields\":{\"NUM\":0}}}},\"id\":\"root\"}]},\"variables\":[]}", "storageType": "STRATEGY" } } } } } } }, "description": "Adds the JSON Configuration Storage (`JCS`).", "tags": [ "Visual Configuration" ] } }, "/update/JCS": { "post": { "summary": "Update a Configuration Storage", "operationId": "post-update-JCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JsonConfigurationStorage" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7f9df9bb9-dsmcx", "data": [ { "version": 2, "typedId": "6.JCS", "name": "NewStrategy", "label": "NewStrategy", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "storageStatus": "DRAFT", "storageType": "STRATEGY", "supersededBy": null, "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"id\":\"root\",\"x\":5,\"y\":5,\"deletable\":false,\"extraState\":{\"variablesConnected\":false},\"fields\":{\"NAME\":\"Strategy\",\"VARIABLES_VISIBLE\":false},\"inputs\":{\"PRICE\":{\"shadow\":{\"type\":\"math_number\",\"id\":\"v{M-:wNRC^(^n$J#amFx\",\"fields\":{\"NUM\":2}}}}}]}}", "updateDate": "2024-07-20T09:55:20", "createDate": "2024-06-20T09:55:20", "createdBy": 2147490187, "lastUpdateDate": "2024-06-20T11:30:58", "lastUpdateBy": 2147490187, "id": 6 } ], "status": 0 } } } } } } } }, "description": "Updates the JSON Configuration Storage (`JCS`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JsonConfigurationStorage" }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "data": { "typedId": "6.JCS", "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"id\":\"root\",\"x\":5,\"y\":5,\"deletable\":false,\"extraState\":{\"variablesConnected\":false},\"fields\":{\"NAME\":\"Strategy\",\"VARIABLES_VISIBLE\":false},\"inputs\":{\"PRICE\":{\"shadow\":{\"type\":\"math_number\",\"id\":\"v{M-:wNRC^(^n$J#amFx\",\"fields\":{\"NUM\":2}}}}}]}}" }, "oldValues": { "version": 1 } } } } } } }, "tags": [ "Visual Configuration" ] } }, "/fetch/JCS": { "post": { "summary": "Get a Configuration Storage", "operationId": "post-fetch-JCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JsonConfigurationStorage" } }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-85ff9ccf66-hk7k7", "data": [ { "version": 2, "typedId": "6.JCS", "name": "NewStrategy", "label": "NewStrategy", "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "storageStatus": "DRAFT", "storageType": "STRATEGY", "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"id\":\"root\",\"x\":5,\"y\":5,\"deletable\":false,\"extraState\":{\"variablesConnected\":false},\"fields\":{\"NAME\":\"Strategy\",\"VARIABLES_VISIBLE\":false},\"inputs\":{\"PRICE\":{\"shadow\":{\"type\":\"math_number\",\"id\":\"v{M-:wNRC^(^n$J#amFx\",\"fields\":{\"NUM\":2}}}}}]}}", "updateDate": "2024-06-20T11:30:58", "createDate": "2024-06-20T09:55:20", "createdBy": 2147490187, "lastUpdateDate": "2024-06-20T11:30:58", "lastUpdateBy": 2147490187, "id": 6 }, { "version": 5, "typedId": "4.JCS", "name": "StrategyTest", "label": "StrategyTest", "createdByName": "beata.handzelova", "lastUpdateByName": "beata.handzelova", "storageStatus": "DRAFT", "storageType": "STRATEGY", "jsonStorage": "{\"blocks\":{\"languageVersion\":0,\"blocks\":[{\"type\":\"strategy_custom\",\"id\":\"root\",\"x\":5,\"y\":5,\"deletable\":false,\"extraState\":{\"variablesConnected\":false},\"fields\":{\"NAME\":\"Strategy\",\"VARIABLES_VISIBLE\":false},\"inputs\":{\"PRICE\":{\"block\":{\"type\":\"math_arithmetic\",\"id\":\"B}NpVix*#A1M+cTbCe5l\",\"fields\":{\"OP\":\"ADD\"},\"inputs\":{\"A\":{\"block\":{\"type\":\"var_productCost\",\"id\":\"%i}};R39_dFKCWe%!}wT\"}},\"B\":{\"block\":{\"type\":\"use_data_lookup\",\"id\":\"H4.Xt9HBbNmh+wSH_}=t\",\"extraState\":{\"selectedDataLookup\":\"AdvancedLookupTest\",\"selectedField\":\"attribute1\",\"outputType\":\"Number\",\"selectedOperator\":\"avg\"},\"fields\":{\"OPERATOR\":\"avg\",\"FIELD\":\"attribute1\",\"DATA_LOOKUP\":\"AdvancedLookupTest\"}}}}}}}}]}}", "updateDate": "2024-06-19T14:02:01", "createDate": "2024-06-19T14:01:18", "createdBy": 2147492445, "lastUpdateDate": "2024-06-19T14:02:01", "lastUpdateBy": 2147492445, "id": 4 } ], "endRow": 2 } } } } } } } }, "description": "Retrieves the JSON Configuration Storage (`JCS`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "`storageType` must be defined within the filter." }, "operator": { "type": "string" }, "value": { "type": "string", "enum": [ "STRATEGY", "STRATEGY_LOOKUP", "FORMULA", "FORMULA_LOOKUP" ] }, "_constructor": { "type": "string" } }, "required": [ "fieldName" ] } } } }, "sortBy": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Example 1": { "value": { "oldValues": null, "operationType": "fetch", "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "storageType", "operator": "equals", "value": "STRATEGY", "_constructor": "AdvancedCriteria" } ] }, "sortBy": [ "-lastUpdateDate" ] } } } } } }, "tags": [ "Visual Configuration" ] } }, "/delete/JCS": { "post": { "summary": "Delete a Configuration Storage", "operationId": "post-delete-JCS", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JsonConfigurationStorage" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Visual Configuration" ], "description": "Deletes the JSON Configuration Storage (`JCS`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example 1": { "value": { "data": { "typedId": "7.JCS" } } } } } } } } }, "/jcsmanager.deploy": { "post": { "summary": "Deploy a Configuration Storage", "operationId": "post-jcsmanager.deploy", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JsonConfigurationStorage" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "node", "data": [ { "version": 1, "typedId": "2.JCS", "name": "JCS 123", "label": null, "createdByName": "ricardo.santos", "lastUpdateByName": "ricardo.santos", "storageStatus": "ACTIVE", "storageType": "STRATEGY", "supersededBy": null, "jsonStorage": "{}", "updateDate": "2024-05-06T11:40:54", "createDate": "2024-05-06T11:37:41", "createdBy": 2147492568, "lastUpdateDate": "2024-05-06T11:40:54", "lastUpdateBy": 2147492568, "id": 2 } ], "status": 0 } } } } } } } }, "tags": [ "Visual Configuration" ], "description": "Deploys the JSON Configuration Storage (`JCS`). Can be only used when storageStatus = `DRAFT`.

\nRequired roles:
\n- `SUPPORT`\n- `PM_FORMULA_DESIGNER_MANAGER`\n- `PB_STRATEGY_DESIGNER_MANAGER`\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedId": { "type": "string" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" } } } } } } } } } }, "/saml/signon": { "post": { "summary": "Authenticate with SAML", "operationId": "post-saml-signon", "responses": { "200": { "description": "OK - Redirects to the target page if a valid session exists." }, "302": { "description": "Found. Redirects to the IdP for authentication if no valid session is found." } }, "tags": [ "Authentication" ], "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "keepSession", "allowEmptyValue": true, "description": "Set to `true` to reuse an existing session and avoid unnecessary roundtrips to the IdP. When set to true, if a valid session is detected, the endpoint will directly redirect to the target page as per RelayState without performing an IdP roundtrip. If no session or an expired session is found, the endpoint will perform the IdP roundtrip as usual." } ], "description": "Redirects to the Identity Provider (IdP) for authentication." } }, "/fetch/LAT": { "post": { "summary": "List Logins", "operationId": "post-fetch-LAT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LoginAuditTrail" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "startRow": 0, "data": [ { "version": 0, "typedId": "2149212731.LAT", "clientIP": "77.78.82.210,130.176.219.42", "userName": "admin", "details": "SUCCESS", "timestamp": "2024-07-01T08:54:08", "createDate": "2024-07-01T08:54:08", "createdBy": 2147490696, "lastUpdateDate": "2024-07-01T08:54:08", "lastUpdateBy": 2147490696 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } }, "401": { "description": "Unauthorized. Wrong password." }, "403": { "description": "Forbidden. Authenticated, but the user has been deactivated." } }, "description": "Retrieves the login application log – `LoginAuditTrail` (LAT).", "tags": [ "Logs" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" } } }, "examples": { "Example 1": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact" } }, "ExampleFiltered": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "userName", "operator": "equals", "value": "admin" } ] } } } } } } } } }, "/fetch/EVT": { "post": { "summary": "List Event Tasks", "operationId": "post-fetch-EVT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventTask" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "string", "startRow": 0, "data": [ { "typedId": "string", "retriesLeft": 0, "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "errorMessage": "string", "name": "string", "httpResponse": 0, "message": "string", "version": 0, "createDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0 } ], "endRow": 0, "totalRows": 0, "status": 0 } } } } } } } }, "tags": [ "Logs" ], "description": "Retrieves a list of events generated by the Pricefx server. See the [Server Events](https://pricefx.atlassian.net/wiki/display/UNITY/Server+Events) article.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "ExampleFiltered": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "name", "operator": "iEquals", "value": "CALCULATION_COMPLETED_PG" } ] } } } } } } } } }, "/fetch/SAT": { "post": { "summary": "List Security & Configuration Events", "operationId": "post-fetch-SAT", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityAuditTrail" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-759b69578b-sl8nj", "startRow": 0, "data": [ { "version": 0, "typedId": "2148351344.SAT", "clientIP": "42.115.94.69,34.120.214.11", "userName": "nhu.doe", "targetObjectType": "User", "targetObjectName": "john.doe", "timestamp": "2024-07-01T07:04:25", "createDate": "2024-07-01T07:04:25", "createdBy": 2147489524, "lastUpdateDate": "2024-07-01T07:04:25", "lastUpdateBy": 2147489524, "action": "CHANGE_PASSWORD" } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Logs" ], "description": "Retrieves events related to security (Management of User Groups, Management of Roles, Pricefx user account deactivation) and some configuration settings (e.g., changing default calculation logics).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "Example 1": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "action", "operator": "equals", "value": "CHANGE_PASSWORD" } ] } } } } } } } } }, "/admin.fetchemailtasks": { "post": { "summary": "List Email Tasks", "operationId": "post-admin.fetchemailtasks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTask" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-b6c678dff-58hnc", "startRow": 0, "data": [ { "version": 1, "typedId": "3041.ET", "retriesLeft": 0, "body": "bodyContent", "subject": "Pricefx - Creation Workflow Finished - Quote: P-2147494428 - New Quote", "sourceObject": "2147494428.Q", "createDate": "2024-07-02T08:43:20", "createdBy": 2147490696, "lastUpdateDate": "2024-07-02T08:43:47", "lastUpdateBy": 2147490696, "recipient": "ondrej.tesar@pricefx.eu", "attachment": false, "sent": true }, { "version": 1, "typedId": "3042.ET", "retriesLeft": 0, "body": "bodyContent", "subject": "Pricefx - Approval Required - Quote: P-2147494428 - New Quote", "sourceObject": "2147494428.Q", "createDate": "2024-07-02T08:43:22", "createdBy": 2147490696, "lastUpdateDate": "2024-07-02T08:43:47", "lastUpdateBy": 2147490696, "recipient": "admin ", "attachment": false, "sent": true } ], "endRow": 2, "totalRows": 2, "status": 0 } } } } } } } }, "tags": [ "Logs", "Admin Tools" ], "description": "Retrieves email tasks that are pending or have already been sent. The response contains a list with all (or filtered out) email task objects (type code: `ET`).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "Example 1": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sourceObject", "operator": "iEquals", "value": "2147494428.Q" } ] } } } } } } } } }, "/accountmanager.audit/{TypeCode}/{id}": { "parameters": [ { "schema": { "type": "string", "enum": [ "R", "UG", "BR" ], "example": "R" }, "name": "TypeCode", "in": "path", "required": true, "description": "Specify whether you want to retrieve a report based on user roles (`R`), user groups (`UG`), or business roles (`BR`)." }, { "schema": { "type": "string", "example": "2" }, "name": "id", "in": "path", "required": true, "description": "Specify the `id`of the user role, user group, or business role for which you want to retrieve users. Call the `/fetch/R`, `/fetch/UG`, or `/fetch/BR` endpoint to retrieve a list with corresponding user roles, user groups, or business roles." } ], "post": { "summary": "Get a User Audit Report", "operationId": "post-accountmanager.audit-TypeCode", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "loginName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } }, "businessRoles": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessRole" } }, "activated": { "type": "boolean" }, "workflowEmailingActivated": { "type": "boolean" }, "noSession": { "type": "boolean" }, "requireTFA": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "ssoOnly": { "type": "boolean" }, "platformManaged": { "type": "boolean" }, "firstLogin": { "type": "boolean" }, "lastTermsOfUseVersionAgreed": { "type": "string" }, "lastTermsOfUseAgreedDate": { "type": "string" }, "allGroups": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "roleNames": { "type": "array", "items": { "type": "string" } }, "allRoleNames": { "type": "array", "items": { "type": "string" } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" } } } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "User Admin", "Logs" ], "description": "Retrieves a report based on user roles, user groups, and business roles.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/streamlokilog": { "get": { "summary": "Get a Loki Log", "tags": [ "Logs" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "data": { "type": "object", "properties": { "resultType": { "type": "string" }, "result": { "type": "array", "items": { "type": "object", "properties": { "stream": { "type": "object", "properties": { "app": { "type": "string" }, "component": { "type": "string" }, "container": { "type": "string" }, "filename": { "type": "string" }, "instance": { "type": "string" }, "job": { "type": "string" }, "namespace": { "type": "string" }, "node_name": { "type": "string" }, "partition": { "type": "string" }, "pod": { "type": "string" }, "stream": { "type": "string" } } }, "values": { "type": "array", "items": { "type": "string" } } } } }, "stats": { "type": "object", "properties": { "summary": { "type": "object", "properties": { "bytesProcessedPerSecond": { "type": "integer" }, "linesProcessedPerSecond": { "type": "integer" }, "totalBytesProcessed": { "type": "integer" }, "totalLinesProcessed": { "type": "integer" }, "execTime": { "type": "number" }, "queueTime": { "type": "number" }, "subqueries": { "type": "integer" }, "totalEntriesReturned": { "type": "integer" }, "splits": { "type": "integer" }, "shards": { "type": "integer" }, "totalPostFilterLines": { "type": "integer" }, "totalStructuredMetadataBytesProcessed": { "type": "integer" } } }, "querier": { "type": "object", "properties": { "store": { "type": "object", "properties": { "totalChunksRef": { "type": "integer" }, "totalChunksDownloaded": { "type": "integer" }, "chunksDownloadTime": { "type": "integer" }, "chunk": { "type": "object", "properties": { "headChunkBytes": { "type": "integer" }, "headChunkLines": { "type": "integer" }, "decompressedBytes": { "type": "integer" }, "decompressedLines": { "type": "integer" }, "compressedBytes": { "type": "integer" }, "totalDuplicates": { "type": "integer" }, "postFilterLines": { "type": "integer" }, "headChunkStructuredMetadataBytes": { "type": "integer" }, "decompressedStructuredMetadataBytes": { "type": "integer" } } }, "chunkRefsFetchTime": { "type": "integer" } } } } }, "ingester": { "type": "object", "properties": { "totalReached": { "type": "integer" }, "totalChunksMatched": { "type": "integer" }, "totalBatches": { "type": "integer" }, "totalLinesSent": { "type": "integer" }, "store": { "type": "object", "properties": { "totalChunksRef": { "type": "integer" }, "totalChunksDownloaded": { "type": "integer" }, "chunksDownloadTime": { "type": "integer" }, "chunk": { "type": "object", "properties": { "headChunkBytes": { "type": "integer" }, "headChunkLines": { "type": "integer" }, "decompressedBytes": { "type": "integer" }, "decompressedLines": { "type": "integer" }, "compressedBytes": { "type": "integer" }, "totalDuplicates": { "type": "integer" }, "postFilterLines": { "type": "integer" }, "headChunkStructuredMetadataBytes": { "type": "integer" }, "decompressedStructuredMetadataBytes": { "type": "integer" } } }, "chunkRefsFetchTime": { "type": "integer" } } } } }, "cache": { "type": "object", "properties": { "chunk": { "type": "object", "properties": { "entriesFound": { "type": "integer" }, "entriesRequested": { "type": "integer" }, "entriesStored": { "type": "integer" }, "bytesReceived": { "type": "integer" }, "bytesSent": { "type": "integer" }, "requests": { "type": "integer" }, "downloadTime": { "type": "integer" } } }, "index": { "type": "object", "properties": { "entriesFound": { "type": "integer" }, "entriesRequested": { "type": "integer" }, "entriesStored": { "type": "integer" }, "bytesReceived": { "type": "integer" }, "bytesSent": { "type": "integer" }, "requests": { "type": "integer" }, "downloadTime": { "type": "integer" } } }, "result": { "type": "object", "properties": { "entriesFound": { "type": "integer" }, "entriesRequested": { "type": "integer" }, "entriesStored": { "type": "integer" }, "bytesReceived": { "type": "integer" }, "bytesSent": { "type": "integer" }, "requests": { "type": "integer" }, "downloadTime": { "type": "integer" } } }, "statsResult": { "type": "object", "properties": { "entriesFound": { "type": "integer" }, "entriesRequested": { "type": "integer" }, "entriesStored": { "type": "integer" }, "bytesReceived": { "type": "integer" }, "bytesSent": { "type": "integer" }, "requests": { "type": "integer" }, "downloadTime": { "type": "integer" } } } } } } } } } } } } } } }, "operationId": "get-streamlokilog", "description": "Retrieves a stream of the Loki log.

\n**Required roles**:
\n- General Admin (without User Management) (`ADMIN_WO_USER_MGMT`)\n- Investigate for Support (`SUPPORT`)", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "start", "description": "A specific point in time as a Unix timestamp where the logging stream should start.", "required": true }, { "schema": { "type": "string", "enum": [ "forward", "backward" ] }, "in": "query", "name": "direction", "required": true, "description": "`forward` to retrieve the logs that were generated after the specified start time." }, { "schema": { "type": "string" }, "in": "query", "name": "limit", "description": "The number of log entries you want to retrieve.", "required": true } ] } }, "/bdmanager.downloaddata/{binaryDataId}": { "parameters": [ { "schema": { "type": "string" }, "name": "binaryDataId", "in": "path", "required": true, "description": "If the typedId is, for example, 1146.BD then the binaryDataId is **1146**." } ], "get": { "summary": "Download an Attachment", "tags": [ "Attachments" ], "responses": { "200": { "description": "OK - binary data", "content": { "application/octet-stream": { "schema": { "type": "object", "properties": {} } } } } }, "operationId": "get-bdmanager.downloaddata-binaryDataId", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "output", "description": "file", "required": true } ], "description": "Downloads the binary data of the attachment." } }, "/optimization.modelduplicate/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Duplicate a Model", "operationId": "post-optimization.modelduplicate-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelObject" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Optimization" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "uniqueName": { "type": "string" }, "label": { "type": "string" }, "modelClassUN": { "type": "string" }, "state": { "type": "object", "properties": { "definition": { "type": "object" } } }, "copyParamTables": { "type": "boolean", "default": true } } }, "operation": { "type": "string" } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-85784f5b7c-jd2t7", "data": [ { "version": 0, "typedId": "59.MO", "uniqueName": "OT_TEST", "label": "OT_TEST", "modelClassUN": "Price_Waterfall", "moduleCategoryUN": null, "userGroupEdit": null, "userGroupViewDetails": null, "currentStep": null, "state": { "definition": { "mapping": { "product": "ProductID", "customer": "CustomerID", "quantity": "Quantity", "net_price": "PocketPrice", "surcharge": "SalesDiscount", "source_name": "DM.datamart_transaction", "invoice_price": "InvoicePrice", "net_net_price": "PocketPrice", "pocket_margin": "GrossMargin", "product_group": "ProductGroup", "product_label": "ProductLabel", "customer_group": "CustomerGroup", "customer_label": "CustomerName", "customer_discount": "VolumeDiscount", "global_list_price": "InvoicePrice", "standard_discount": "StdDiscount", "product_group_label": "ProductGroup", "specific_list_price": "ListPrice", "customer_group_label": "CustomerGroup", "transaction_data_filter": null, "negotiation_guidance_model": null } } }, "createdByName": "ondrej.tesar", "lastUpdateByName": "ondrej.tesar", "submittedBy": null, "submittedByName": null, "approvedBy": null, "approvedByName": null, "deniedBy": null, "deniedByName": null, "submitDate": null, "workflowStatus": "DRAFT", "status": "DRAFT", "createDate": "2024-08-30T09:32:41", "createdBy": 2147490187, "lastUpdateDate": "2024-08-30T09:32:41", "lastUpdateBy": 2147490187, "id": 59 } ], "status": 0 } } } } } } }, "description": "Creates a copy of the specified model with a new name, including the parameter tables (if `copyParamTables=true`)." } }, "/conditionrecordset.fetch/CRCI3": { "post": { "summary": "Get Condition Record Set Items With Set Id Validation", "tags": [ "Condition Records" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionRecordItem3Key" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "2.CRCI3", "conditionRecordSetId": 3, "validTo": "2030-10-10T00:00:00", "validFrom": "2030-01-01T00:00:00", "conditionValue": 50, "unitOfMeasure": "kg", "currency": "EUR", "createdByObj": "2147483656.PL", "createDate": "2024-10-25T11:07:28", "createdBy": 2147492577, "lastUpdateDate": "2024-10-25T11:07:28", "lastUpdateBy": 2147492577, "attribute3": "attr3 VAL222", "attribute4": "attr4 VAL3333", "key1": "PL Test 1", "key2": "01", "key3": "P-0001" }, { "version": 0, "typedId": "3.CRCI3", "conditionRecordSetId": 3, "validTo": "2030-10-10T00:00:00", "validFrom": "2030-01-01T00:00:00", "conditionValue": 50, "unitOfMeasure": "kg", "currency": "EUR", "createdByObj": "2147483656.PL", "createDate": "2024-10-25T11:07:28", "createdBy": 2147492577, "lastUpdateDate": "2024-10-25T11:07:28", "lastUpdateBy": 2147492577, "attribute3": "attr3 VAL222", "attribute4": "attr4 VAL3333", "key1": "PL Test 1", "key2": "01", "key3": "P-0002" } ], "endRow": 2, "totalRows": 2, "status": 0 } } }, "Example 2": { "value": { "response": { "status": 0, "startRow": 0, "node": "pricefx-cluster-app-frontend-7b7fdd5759-6h6mr", "data": [ { "version": 0, "typedId": "3.CRCI12", "conditionRecordSetId": 7, "validTo": "2025-02-01T14:10:00", "validFrom": "2024-02-01T14:10:00", "integrationStatus": 0, "createDate": "2024-06-19T10:45:40", "createdBy": 2147490696, "lastUpdateDate": "2024-06-19T10:45:40", "lastUpdateBy": 2147490696, "key1": "k", "key2": "l", "key3": "m", "key4": "n", "key5": "o", "key6": "p", "key7": "q", "key8": "r", "key9": "s", "key10": "t", "key11": "u", "key12": "v" } ], "endRow": 1 } } } } } } } }, "operationId": "post-conditionrecordset-fetch-CRCI3", "description": "Retrieves Condition Record Items with 3 keys (`CRCI3`) from the specified Condition Record Set.\n\n>You can use the `CRCI1`..`CRCI12` type codes in the path to retrieve Condition Record Items with different number of keys. You can check for mandatory parameters, e. g.`conditionRecordSetId`.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] } } } } } } } }, "examples": { "Example 1": { "value": { "endRow": 300, "oldValues": { "type": "object" }, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "unitOfMeasure", "operator": "iContains", "value": "kg" }, { "fieldName": "conditionRecordSetId", "operator": "equals", "value": 3 } ] } } } } } } } }, "parameters": [] }, "/fetch/PLTT": { "post": { "summary": "List Price List Types", "tags": [ "Price Lists" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListType" } }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "data": [ { "version": 0, "typedId": "5.PLTT", "uniqueName": "PLType1", "label": "Price List Type 1", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "typeConfiguration": { "errorMode": "SKIP", "elementNames": [], "overridableFields": [], "resultElementName": "ListPrice", "hiddenElementNames": [], "notifyWhenFinished": "EMAIL", "shotgunModeEnabled": false, "calculationLogicInputs": [ { "name": "Customer Type", "type": "OPTION", "label": "Customer Type", "inputs": [], "valueOptions": [ "Industry", "Distributor", "Direct Customer", "Direct", "Distributors" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Classification", "type": "OPTION", "label": "Classification", "inputs": [], "valueOptions": [ "A", "B", "C" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Account Group", "type": "OPTION", "label": "Account Group", "inputs": [], "valueOptions": [ "Global customer", "Sold-to", "Ship-to" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Region", "type": "OPTION", "label": "Region", "inputs": [], "valueOptions": [ "California", "Arizona", "Illinois", "Kentucky", "Texas", "Washington", "Hessen", "Bayern", "Île-de-France", "Midi-Pyrénées", "City", "Manchester", "Singapore", "Shanghai", "Jiangsu", "Michigan", "Disctrict of Columbia", "Florida", "India", "Baden-Württemberg", "Prague", "Austria", "Birmingham", "Northamptonshire", "Massachusetts", "Hamburg", "Noord-Holland", "Belgium", "Moravskoslezský", "Merseyside", "Zhejiang", "Guangdong", "Masovian", "Schwyz", "Provence-Alpes-Côte-d'Azur", "Southampton", "Ohio", "Minnesota", "Georgia", "Královéhradecký", "Gelderlaand", "Zürich", "Aargau", "Milan", "North Carolina", "South Carolina", "Sachsen", "Nordrhein-Westfalen", "Aquitaine", "Rhône-Alpes", "Pays de la Loire", "Madrid", "Barcelona", "Vietnam", "Beijing", "Oklahoma", "Zuid-Holland", "AMER", "APAC", "EMEA" ], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "CustomerType", "Cost", "ListPrice" ], "calcLogicInputsOverridableFields": [] }, "buttonsConfiguration": {}, "headerFormulaName": "AttrBasedPricingLogicHeader", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "contextualActions": {}, "createDate": "2024-11-15T09:32:07", "createdBy": 1302, "lastUpdateDate": "2024-11-15T09:32:07", "lastUpdateBy": 1302, "id": 5 }, { "version": 0, "typedId": "6.PLTT", "uniqueName": "PLType2", "label": "Price List Type 2", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "typeConfiguration": { "errorMode": "SKIP", "elementNames": [], "overridableFields": [ "userGroupEdit", "userGroupViewDetails", "userGroupCanUseType", "preferencesSource" ], "resultElementName": "ListPrice", "hiddenElementNames": [], "notifyWhenFinished": "EMAIL", "shotgunModeEnabled": false, "calculationLogicInputs": [ { "name": "ProductSKU", "type": "PRODUCT", "label": "ProductSKU", "inputs": [], "parameterConfig": { "dataType": "product" }, "formattingOptions": {} }, { "url": "CustomerNetPriceList_Configurator", "name": "InputConfigurator", "type": "INLINECONFIGURATOR", "label": "InputConfigurator", "value": { "Customer": "CID-0001", "Dependent Level Name": "United States of America", "Independent Level Name": "Global" }, "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "Customer", "ListPriceData", "ProductId", "Cost", "ListPrice" ], "calcLogicInputsOverridableFields": [ "ProductSKU", "InputConfigurator" ] }, "buttonsConfiguration": {}, "dimensionType": "SIMPLE", "calculationFormulaName": "CustomerNetPriceLogic", "contextualActions": {}, "createDate": "2024-11-15T09:35:52", "createdBy": 1302, "lastUpdateDate": "2024-11-15T09:35:52", "lastUpdateBy": 1302, "id": 6 } ], "endRow": 2 } } } } } } } }, "operationId": "post-fetch-PLTT", "description": "Retrieves a list of Price List Types." }, "parameters": [] }, "/fetch/PGTT": { "post": { "summary": "List Live Price Grid Types", "tags": [ "Live Price Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LivePriceGridType" } }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "data": [ { "version": 0, "typedId": "7.PGTT", "uniqueName": "LPGType1", "label": "Live Price Grid Type 1", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "typeConfiguration": { "elementNames": [], "dynamicItemMode": "auto", "approvalMappings": [ "testFormula" ], "overridableFields": [], "resultElementName": "ListPrice", "hiddenElementNames": [], "shotgunModeEnabled": false, "allowFieldTypeChange": true, "approvalTriggerFields": [], "calculationLogicInputs": [ { "name": "Customer Type", "type": "OPTION", "label": "Customer Type", "inputs": [], "valueOptions": [ "Industry", "Distributor", "Direct Customer", "Direct", "Distributors" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Classification", "type": "OPTION", "label": "Classification", "inputs": [], "valueOptions": [ "A", "B", "C" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Account Group", "type": "OPTION", "label": "Account Group", "inputs": [], "valueOptions": [ "Global customer", "Sold-to", "Ship-to" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Region", "type": "OPTION", "label": "Region", "inputs": [], "valueOptions": [ "California", "Arizona", "Illinois", "Kentucky", "Texas", "Washington", "Hessen", "Bayern", "Île-de-France", "Midi-Pyrénées", "City", "Manchester", "Singapore", "Shanghai", "Jiangsu", "Michigan", "Disctrict of Columbia", "Florida", "India", "Baden-Württemberg", "Prague", "Austria", "Birmingham", "Northamptonshire", "Massachusetts", "Hamburg", "Noord-Holland", "Belgium", "Moravskoslezský", "Merseyside", "Zhejiang", "Guangdong", "Masovian", "Schwyz", "Provence-Alpes-Côte-d'Azur", "Southampton", "Ohio", "Minnesota", "Georgia", "Královéhradecký", "Gelderlaand", "Zürich", "Aargau", "Milan", "North Carolina", "South Carolina", "Sachsen", "Nordrhein-Westfalen", "Aquitaine", "Rhône-Alpes", "Pays de la Loire", "Madrid", "Barcelona", "Vietnam", "Beijing", "Oklahoma", "Zuid-Holland", "AMER", "APAC", "EMEA" ], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "ListPrice", "Cost", "CustomerType", "resultPrice", "previousPrice", "previousPriceDate", "activePrice", "activePriceDate" ], "calcLogicInputsOverridableFields": [] }, "buttonsConfiguration": {}, "headerFormulaName": "AttrBasedPricingLogicHeader", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "contextualActions": {}, "createDate": "2024-11-15T10:44:57", "createdBy": 1302, "lastUpdateDate": "2024-11-15T10:44:57", "lastUpdateBy": 1302, "id": 7 }, { "version": 0, "typedId": "8.PGTT", "uniqueName": "LPGType2", "label": "Live Price Grid Type 2", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "typeConfiguration": { "elementNames": [], "dynamicItemMode": "auto", "approvalMappings": [ "testFormula" ], "overridableFields": [ "dimensionType", "shotgunModeEnabled", "allowFieldTypeChange", "defaultFormulaOverride", "resultElementName", "uomOverrideElementName", "currencyOverrideElementName", "autoApproveElementName", "manualResultExpiryElementName" ], "resultElementName": "ListPrice", "hiddenElementNames": [], "shotgunModeEnabled": false, "allowFieldTypeChange": true, "approvalTriggerFields": [], "calculationLogicInputs": [ { "name": "ProductSKU", "type": "PRODUCT", "label": "ProductSKU", "inputs": [], "parameterConfig": { "dataType": "product" }, "formattingOptions": {} }, { "url": "CustomerNetPriceList_Configurator", "name": "InputConfigurator", "type": "INLINECONFIGURATOR", "label": "InputConfigurator", "value": { "Customer": "CID-0001", "Dependent Level Name": "United States of America", "Independent Level Name": "Global" }, "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "ListPrice", "BusinessUnit", "InvoicePrice", "Customer", "previousPrice", "previousPriceDate", "activePrice", "activePriceDate", "resultPrice", "manualResultPrice" ], "calcLogicInputsOverridableFields": [ "ProductSKU", "InputConfigurator" ] }, "buttonsConfiguration": {}, "dimensionType": "SIMPLE", "calculationFormulaName": "CustomerNetPriceLogic", "contextualActions": {}, "createDate": "2024-11-15T10:52:02", "createdBy": 1302, "lastUpdateDate": "2024-11-15T10:52:02", "lastUpdateBy": 1302, "id": 8 } ], "endRow": 3 } } } } } } } }, "operationId": "post-fetch-PGTT", "description": "Retrieves a list of Live Price Grid Types." } }, "/delete/PLTT": { "post": { "summary": "Delete a Price List Type", "tags": [ "Price Lists" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "8.PLTT", "uniqueName": "PLType3", "label": "Price List Type 3", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "userGroupEdit": "[Actin] Watchers Manager", "userGroupViewDetails": "[Actin] Watchers Analyst", "userGroupCanUseType": "[Actin] Watchers Contributor", "typeConfiguration": { "elementNames": [], "overridableFields": [], "resultElementName": "ListPrice", "hiddenElementNames": [], "shotgunModeEnabled": false, "calculationLogicInputs": [ { "name": "Customer Type", "type": "OPTION", "label": "Customer Type", "inputs": [], "valueOptions": [ "Industry", "Distributor", "Direct Customer", "Direct", "Distributors" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Classification", "type": "OPTION", "label": "Classification", "inputs": [], "valueOptions": [ "A", "B", "C" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Account Group", "type": "OPTION", "label": "Account Group", "inputs": [], "valueOptions": [ "Global customer", "Sold-to", "Ship-to" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Region", "type": "OPTION", "label": "Region", "inputs": [], "valueOptions": [ "California", "Arizona", "Illinois", "Kentucky", "Texas", "Washington", "Hessen", "Bayern", "Île-de-France", "Midi-Pyrénées", "City", "Manchester", "Singapore", "Shanghai", "Jiangsu", "Michigan", "Disctrict of Columbia", "Florida", "India", "Baden-Württemberg", "Prague", "Austria", "Birmingham", "Northamptonshire", "Massachusetts", "Hamburg", "Noord-Holland", "Belgium", "Moravskoslezský", "Merseyside", "Zhejiang", "Guangdong", "Masovian", "Schwyz", "Provence-Alpes-Côte-d'Azur", "Southampton", "Ohio", "Minnesota", "Georgia", "Královéhradecký", "Gelderlaand", "Zürich", "Aargau", "Milan", "North Carolina", "South Carolina", "Sachsen", "Nordrhein-Westfalen", "Aquitaine", "Rhône-Alpes", "Pays de la Loire", "Madrid", "Barcelona", "Vietnam", "Beijing", "Oklahoma", "Zuid-Holland", "AMER", "APAC", "EMEA" ], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "ListPrice" ], "calcLogicInputsOverridableFields": [] }, "buttonsConfiguration": {}, "headerFormulaName": "Attribute Based Pricing Logic Header", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "matrixFormulaName": "PSS_MatrixDevLogic", "matrixFormulaElementName": "Countries", "contextualActions": {}, "createDate": "2024-11-15T11:35:47", "createdBy": 1302, "lastUpdateDate": "2024-11-15T11:35:47", "lastUpdateBy": 1302, "id": 8 } ], "status": 0 } } } } } } } }, "operationId": "post-delete-PLTT", "description": "Deletes the specified Price List Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "typedId": { "type": "string" } } } } }, "examples": { "Example 1": { "value": { "operationType": "remove", "textMatchStyle": "exact", "data": { "typedId": "8.PLTT" } } } } } } } } }, "/delete/PGTT": { "post": { "summary": "Delete a Live Price Grid Type", "tags": [ "Live Price Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LivePriceGridType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "9.PGTT", "uniqueName": "LPGType3", "label": "Live Price Grid Type 3", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2024-11-15", "userGroupEdit": "[Actin] Watchers Manager", "userGroupViewDetails": "[Actin] Watchers Analyst", "userGroupCanUseType": "[Actin] Watchers Contributor", "typeConfiguration": { "elementNames": [ "ListPrice" ], "dynamicItemMode": "auto", "approvalMappings": [ "testFormula" ], "overridableFields": [], "resultElementName": "ListPrice", "hiddenElementNames": [], "shotgunModeEnabled": false, "allowFieldTypeChange": false, "approvalTriggerFields": [], "calculationLogicInputs": [ { "name": "Customer Type", "type": "OPTION", "label": "Customer Type", "inputs": [], "valueOptions": [ "Industry", "Distributor", "Direct Customer", "Direct", "Distributors" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Classification", "type": "OPTION", "label": "Classification", "inputs": [], "valueOptions": [ "A", "B", "C" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Account Group", "type": "OPTION", "label": "Account Group", "inputs": [], "valueOptions": [ "Global customer", "Sold-to", "Ship-to" ], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Region", "type": "OPTION", "label": "Region", "inputs": [], "valueOptions": [ "California", "Arizona", "Illinois", "Kentucky", "Texas", "Washington", "Hessen", "Bayern", "Île-de-France", "Midi-Pyrénées", "City", "Manchester", "Singapore", "Shanghai", "Jiangsu", "Michigan", "Disctrict of Columbia", "Florida", "India", "Baden-Württemberg", "Prague", "Austria", "Birmingham", "Northamptonshire", "Massachusetts", "Hamburg", "Noord-Holland", "Belgium", "Moravskoslezský", "Merseyside", "Zhejiang", "Guangdong", "Masovian", "Schwyz", "Provence-Alpes-Côte-d'Azur", "Southampton", "Ohio", "Minnesota", "Georgia", "Královéhradecký", "Gelderlaand", "Zürich", "Aargau", "Milan", "North Carolina", "South Carolina", "Sachsen", "Nordrhein-Westfalen", "Aquitaine", "Rhône-Alpes", "Pays de la Loire", "Madrid", "Barcelona", "Vietnam", "Beijing", "Oklahoma", "Zuid-Holland", "AMER", "APAC", "EMEA" ], "parameterConfig": {}, "formattingOptions": {} } ], "userCanToggleVisibility": [ "ListPrice", "previousPrice", "previousPriceDate", "activePrice", "activePriceDate", "resultPrice" ], "calcLogicInputsOverridableFields": [] }, "buttonsConfiguration": {}, "headerFormulaName": "Attribute Based Pricing Logic Header", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "matrixFormulaName": "PSS_MatrixDevLogic", "matrixFormulaElementName": "Countries", "contextualActions": {}, "createDate": "2024-11-15T12:01:06", "createdBy": 1302, "lastUpdateDate": "2024-11-15T12:01:06", "lastUpdateBy": 1302, "id": 9 } ], "status": 0 } } } } } } } }, "operationId": "post-delete-PGTT", "description": "Deletes the specified Live Price Grid Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "typedId": { "type": "string" } } } } }, "examples": { "Example 1": { "value": { "operationType": "remove", "textMatchStyle": "exact", "data": { "typedId": "9.PGTT" } } } } } }, "description": "" } } }, "/add/PLTT": { "post": { "summary": "Add a Price List Type", "tags": [ "Price Lists" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "11.PLTT", "uniqueName": "PLType5", "label": "Price List Type 5", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2030-01-01", "userGroupEdit": "[Actin] Watchers Manager", "userGroupViewDetails": "[Actin] Watchers Analyst", "userGroupCanUseType": "[Actin] Watchers Contributor", "typeConfiguration": { "errorMode": "SKIP", "elementNames": [ "ListPrice", "ProductGroup", "BusinessUnit", "Cost", "CustomerType" ], "headerInputs": [ { "name": "input", "type": "INTEGERUSERENTRY", "label": "input", "value": 10, "inputs": [] } ], "overridableFields": [ "calculationLogic" ], "resultElementName": "ListPrice", "hiddenElementNames": [ "Strech" ], "notifyWhenFinished": "EMAIL", "shotgunModeEnabled": false, "productFilterCriteria": { "criteria": [ { "value": [ "B-0001", "B-0002" ], "operator": "inSet", "fieldName": "sku" } ], "operator": "and", "_constructor": "AdvancedCriteria" }, "calculationLogicInputs": [ { "url": "ConfiguratorWithOptionsInputEntries", "name": "Configuration", "type": "CONFIGURATOR", "label": "Configuration", "value": {}, "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "warning", "type": "BOOLEANUSERENTRY", "label": "Add Warning?", "value": false, "inputs": [] }, { "name": "Quantity", "type": "USERENTRY", "label": "Quantity", "value": 100, "inputs": [], "parameterConfig": { "dataType": "float" } }, { "url": "/lookuptablemanager.fetch/2147483653", "name": "MassiveDiscount", "type": "LOOKUP", "label": "MassiveDiscount", "inputs": [], "lookupTableId": "2147483653", "parameterConfig": {}, "formattingOptions": {} }, { "url": "/fetch/C/", "name": "Customer", "type": "CUSTOMER", "label": "Customer", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Decimal Places", "type": "OPTION", "label": "Decimal Places?", "inputs": [], "valueOptions": [ "0", "1", "2", "3", "4", "5" ], "parameterConfig": { "dataType": "integer", "inputType": "drop-down" }, "formattingOptions": {} }, { "name": "Surcharge", "type": "MULTITIERENTRY", "label": "Surcharge", "inputs": [], "valueHint": "each^^^€", "parameterConfig": {}, "formattingOptions": {} } ], "relativeTargetDateDays": 3, "uomOverrideElementName": "Cost", "userCanToggleVisibility": [ "ListPrice" ], "currencyOverrideElementName": "", "calcLogicInputsOverridableFields": [ "Input A" ] }, "buttonsConfiguration": { "key3": "value" }, "headerFormulaName": "Attribute Based Pricing Logic Header", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element", "customActionLogics": "{key1=value}", "contextualActions": { "key2": "value" }, "createDate": "2024-11-18T11:32:44", "createdBy": 1302, "lastUpdateDate": "2024-11-18T11:32:44", "lastUpdateBy": 1302, "id": 11 } ], "status": 0 } } } } } } } }, "operationId": "post-add-PLTT", "description": "Creates a Price List Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "operationType": "add", "textMatchStyle": "exact", "data": { "uniqueName": "PLType5", "label": "Price List Type 5", "targetDate": "2030-01-01", "userGroupViewDetails": "[Actin] Watchers Analyst", "userGroupEdit": "[Actin] Watchers Manager", "userGroupCanUseType": "[Actin] Watchers Contributor", "headerFormulaName": "Attribute Based Pricing Logic Header", "dimensionType": "SIMPLE", "calculationFormulaName": "OptimizedPricingLogic", "typeConfiguration": { "relativeTargetDateDays": 3, "headerInputs": [ { "name": "input", "label": "input", "type": "INTEGERUSERENTRY", "value": 10, "inputs": [] } ], "shotgunModeEnabled": false, "resultElementName": "ListPrice", "productFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "inSet", "value": [ "B-0001", "B-0002" ] } ] }, "uomOverrideElementName": "Cost", "currencyOverrideElementName": "", "errorMode": "SKIP", "notifyWhenFinished": "EMAIL", "calculationLogicInputs": [ { "name": "Configuration", "label": "Configuration", "url": "ConfiguratorWithOptionsInputEntries", "type": "CONFIGURATOR", "value": {}, "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "warning", "label": "Add Warning?", "type": "BOOLEANUSERENTRY", "value": {}, "inputs": [] }, { "name": "Quantity", "label": "Quantity", "type": "USERENTRY", "value": 100, "inputs": [], "parameterConfig": { "dataType": "float" } }, { "name": "MassiveDiscount", "label": "MassiveDiscount", "lookupTableId": "2147483653", "url": "/lookuptablemanager.fetch/2147483653", "type": "LOOKUP", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Customer", "label": "Customer", "lookupTableId": "2147483653", "url": "/fetch/C/", "type": "CUSTOMER", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Decimal Places", "label": "Decimal Places?", "type": "OPTION", "inputs": [], "parameterConfig": { "dataType": "integer", "inputType": "drop-down" }, "formattingOptions": {}, "valueOptions": [ "0", "1", "2", "3", "4", "5" ] }, { "name": "Surcharge", "label": "Surcharge", "type": "MULTITIERENTRY", "valueHint": "each^^^€", "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "elementNames": [ "ListPrice", "ProductGroup", "BusinessUnit", "Cost", "CustomerType" ], "hiddenElementNames": [ "Strech" ], "userCanToggleVisibility": [ "ListPrice" ], "overridableFields": [ "calculationLogic" ], "calcLogicInputsOverridableFields": [ "Input A" ] }, "customActionLogics": { "key1": "value" }, "contextualActions": { "key2": "value" }, "buttonsConfiguration": { "key3": "value" } } } } } } }, "description": "" } } }, "/add/PGTT": { "post": { "summary": "Add a Live Price Grid Type", "tags": [ "Live Price Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LivePriceGridType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "3.PGTT", "uniqueName": "Price Grid Type 1", "label": "Price Grid Type 1 Label", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice", "SecretFormula", "currencyElement" ], "headerInputs": [ { "name": "input", "type": "INTEGERUSERENTRY", "label": "input", "value": 10, "inputs": [] } ], "maxDecreasePct": 2, "maxIncreasePct": 1, "dynamicItemMode": "ADD_ONLY", "approvalMappings": [ "testFormula" ], "overridableFields": [ "calculationLogic" ], "preferencesSource": "123", "resultElementName": "resultPrice", "hiddenElementNames": [ "SecretFormula" ], "shotgunModeEnabled": false, "allowColumnTypeChange": false, "approvalTriggerFields": [ "SecretFormula" ], "productFilterCriteria": { "criteria": [ { "value": [ "B-0001", "B-0002" ], "operator": "inSet", "fieldName": "sku" } ], "operator": "and", "_constructor": "AdvancedCriteria" }, "autoApproveElementName": "resultPrice", "calculationLogicInputs": [ { "url": "ConfiguratorWithOptionsInputEntries", "name": "Configuration", "type": "CONFIGURATOR", "label": "Configuration", "value": {}, "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "warning", "type": "BOOLEANUSERENTRY", "label": "Add Warning?", "value": false, "inputs": [] }, { "name": "Quantity", "type": "USERENTRY", "label": "Quantity", "value": 100, "inputs": [], "parameterConfig": { "dataType": "float" } }, { "url": "/lookuptablemanager.fetch/2147483653", "name": "MassiveDiscount", "type": "LOOKUP", "label": "MassiveDiscount", "inputs": [], "lookupTableId": "2147483653", "parameterConfig": {}, "formattingOptions": {} }, { "url": "/fetch/C/", "name": "Customer", "type": "CUSTOMER", "label": "Customer", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Decimal Places", "type": "OPTION", "label": "Decimal Places?", "inputs": [], "valueOptions": [ "0", "1", "2", "3", "4", "5" ], "parameterConfig": { "dataType": "integer", "inputType": "drop-down" }, "formattingOptions": {} }, { "name": "Surcharge", "type": "MULTITIERENTRY", "label": "Surcharge", "inputs": [], "valueHint": "each^^^€", "parameterConfig": {}, "formattingOptions": {} } ], "relativeTargetDateDays": 3, "uomOverrideElementName": "SecretFormula", "userCanToggleVisibility": [ "SecretFormula" ], "currencyOverrideElementName": "currencyElement", "manualResultExpiryElementName": "ElementB", "calcLogicInputsOverridableFields": [ "Input A" ] }, "buttonsConfiguration": { "key3": "value" }, "headerFormulaName": "Header Formula", "dimensionType": "MATRIX", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element 123", "customActionLogics": "{key1=value}", "contextualActions": { "key2": "value" }, "createDate": "2024-11-11T13:04:16", "createdBy": 1302, "lastUpdateDate": "2024-11-11T13:04:16", "lastUpdateBy": 1302, "id": 3 } ], "status": 0 } } } } } } } }, "operationId": "post-add-PGTT", "description": "Creates a Live Price Grid Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "uniqueName": { "type": "string" }, "label": { "type": "string" }, "targetDate": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupCanUseType": { "type": "string" }, "headerFormulaName": { "type": "string" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "matrixFormulaName": { "type": "string" }, "matrixFormulaElementName": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "relativeTargetDateDays": { "type": "integer" }, "preferencesSource": { "type": "string" }, "headerInputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object", "properties": {} } } } } }, "shotgunModeEnabled": { "type": "boolean" }, "allowColumnTypeChange": { "type": "boolean" }, "resultElementName": { "type": "string" }, "dynamicItemMode": { "type": "string" }, "productFilterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "string" } } } } } } }, "uomOverrideElementName": { "type": "string" }, "currencyOverrideElementName": { "type": "string" }, "autoApproveElementName": { "type": "string" }, "manualResultExpiryElementName": { "type": "string" }, "maxIncreasePct": { "type": "integer" }, "maxDecreasePct": { "type": "integer" }, "calculationLogicInputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "oneOf": [ { "type": "object" }, { "type": "boolean" }, { "type": "array" }, { "type": "integer" } ], "properties": {} }, "inputs": { "type": "array", "items": { "type": "object", "properties": {} } }, "parameterConfig": { "type": "object", "properties": {} }, "formattingOptions": { "type": "object", "properties": {} }, "lookupTableId": { "type": "string" }, "valueHint": { "type": "string" } } } }, "elementNames": { "type": "array", "items": { "type": "string" } }, "hiddenElementNames": { "type": "array", "items": { "type": "string" } }, "approvalTriggerFields": { "type": "array", "items": { "type": "string" } }, "userCanToggleVisibility": { "type": "array", "items": { "type": "string" } }, "approvalMappings": { "type": "array", "items": { "type": "string" } }, "overridableFields": { "type": "array", "items": { "type": "string" } }, "calcLogicInputsOverridableFields": { "type": "array", "items": { "type": "string" } } } }, "customActionLogics": { "type": "object", "properties": { "key1": { "type": "string" } } }, "contextualActions": { "type": "object", "properties": { "key2": { "type": "string" } } }, "buttonsConfiguration": { "type": "object", "properties": { "key3": { "type": "string" } } } } } } }, "examples": { "Example 1": { "value": { "operationType": "add", "textMatchStyle": "exact", "data": { "uniqueName": "Price Grid Type 1", "label": "Price Grid Type 1 Label", "targetDate": "2030-01-01", "userGroupViewDetails": "Group A", "userGroupEdit": "Group B", "userGroupCanUseType": "Group C", "headerFormulaName": "Header Formula", "dimensionType": "MATRIX", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element 123", "typeConfiguration": { "relativeTargetDateDays": 3, "preferencesSource": "123", "headerInputs": [ { "name": "input", "label": "input", "type": "INTEGERUSERENTRY", "value": 10, "inputs": [] } ], "shotgunModeEnabled": false, "allowColumnTypeChange": false, "resultElementName": "resultPrice", "dynamicItemMode": "ADD_ONLY", "productFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "inSet", "value": [ "B-0001", "B-0002" ] } ] }, "uomOverrideElementName": "SecretFormula", "currencyOverrideElementName": "currencyElement", "autoApproveElementName": "resultPrice", "manualResultExpiryElementName": "ElementB", "maxIncreasePct": 1, "maxDecreasePct": 2, "calculationLogicInputs": [ { "name": "Configuration", "label": "Configuration", "url": "ConfiguratorWithOptionsInputEntries", "type": "CONFIGURATOR", "value": {}, "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "warning", "label": "Add Warning?", "type": "BOOLEANUSERENTRY", "value": false, "inputs": [] }, { "name": "Quantity", "label": "Quantity", "type": "USERENTRY", "value": 100, "inputs": [], "parameterConfig": { "dataType": "float" } }, { "name": "MassiveDiscount", "label": "MassiveDiscount", "lookupTableId": "2147483653", "url": "/lookuptablemanager.fetch/2147483653", "type": "LOOKUP", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Customer", "label": "Customer", "lookupTableId": "2147483653", "url": "/fetch/C/", "type": "CUSTOMER", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Decimal Places", "label": "Decimal Places?", "type": "OPTION", "inputs": [], "parameterConfig": { "dataType": "integer", "inputType": "drop-down" }, "formattingOptions": {}, "valueOptions": [ "0", "1", "2", "3", "4", "5" ] }, { "name": "Surcharge", "label": "Surcharge", "type": "MULTITIERENTRY", "valueHint": "each^^^€", "inputs": [], "parameterConfig": {}, "formattingOptions": {} } ], "elementNames": [ "testFormula", "ElementB", "resultPrice", "SecretFormula", "currencyElement" ], "hiddenElementNames": [ "SecretFormula" ], "approvalTriggerFields": [ "SecretFormula" ], "userCanToggleVisibility": [ "SecretFormula" ], "approvalMappings": [ "testFormula" ], "overridableFields": [ "calculationLogic" ], "calcLogicInputsOverridableFields": [ "Input A" ] }, "customActionLogics": { "key1": "value" }, "contextualActions": { "key2": "value" }, "buttonsConfiguration": { "key3": "value" } } } } } } } } } }, "/update/PGTT": { "post": { "summary": "Update a Live Price Grid Type", "tags": [ "Live Price Grids" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LivePriceGridType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "3.PGTT", "uniqueName": "Price Grid Type 1", "label": "Price Grid Type 1 Label", "createdByName": "unity", "lastUpdateByName": "unity", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice", "SecretFormula", "currencyElement" ], "headerInputs": [ { "name": "input", "type": "INTEGERUSERENTRY", "label": "input", "value": 10, "inputs": [] } ], "maxDecreasePct": 2, "maxIncreasePct": 1, "dynamicItemMode": "ADD_ONLY", "approvalMappings": [ "testFormula" ], "overridableFields": [ "calculationLogic" ], "preferencesSource": "123", "resultElementName": "resultPrice", "hiddenElementNames": [ "SecretFormula" ], "shotgunModeEnabled": false, "allowColumnTypeChange": false, "approvalTriggerFields": [ "SecretFormula" ], "productFilterCriteria": { "criteria": [ { "value": [ "B-0001", "B-0002" ], "operator": "inSet", "fieldName": "sku" } ], "operator": "and", "_constructor": "AdvancedCriteria" }, "autoApproveElementName": "resultPrice", "calculationLogicInputs": [ { "url": "ConfiguratorWithOptionsInputEntries", "name": "Configuration", "type": "CONFIGURATOR", "label": "Configuration", "value": {}, "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "warning", "type": "BOOLEANUSERENTRY", "label": "Add Warning?", "value": false, "inputs": [] }, { "name": "Quantity", "type": "USERENTRY", "label": "Quantity", "value": 100, "inputs": [], "parameterConfig": { "dataType": "float" } }, { "url": "/lookuptablemanager.fetch/2147483653", "name": "MassiveDiscount", "type": "LOOKUP", "label": "MassiveDiscount", "inputs": [], "lookupTableId": "2147483653", "parameterConfig": {}, "formattingOptions": {} }, { "url": "/fetch/C/", "name": "Customer", "type": "CUSTOMER", "label": "Customer", "inputs": [], "parameterConfig": {}, "formattingOptions": {} }, { "name": "Decimal Places", "type": "OPTION", "label": "Decimal Places?", "inputs": [], "valueOptions": [ "0", "1", "2", "3", "4", "5" ], "parameterConfig": { "dataType": "integer", "inputType": "drop-down" }, "formattingOptions": {} }, { "name": "Surcharge", "type": "MULTITIERENTRY", "label": "Surcharge", "inputs": [], "valueHint": "each^^^€", "parameterConfig": {}, "formattingOptions": {} } ], "relativeTargetDateDays": 3, "uomOverrideElementName": "SecretFormula", "userCanToggleVisibility": [ "SecretFormula" ], "currencyOverrideElementName": "currencyElement", "manualResultExpiryElementName": "ElementB", "calcLogicInputsOverridableFields": [ "Input A" ] }, "buttonsConfiguration": { "key3": "value" }, "headerFormulaName": "Header Formula", "dimensionType": "MATRIX", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element 123", "customActionLogics": "{key1=value}", "contextualActions": { "key2": "value" }, "createDate": "2024-11-11T13:04:16", "createdBy": 1302, "lastUpdateDate": "2024-11-11T13:04:16", "lastUpdateBy": 1302, "id": 3 } ], "status": 0 } } } } }, "application/xml": { "schema": { "type": "object", "properties": {} } } } } }, "operationId": "post-update-PGTT", "description": "Updates the Live Price Grid Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "targetDate": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "userGroupCanUseType": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "elementNames": { "type": "array", "items": { "type": "string" } }, "dynamicItemMode": { "type": "string" }, "resultElementName": { "type": "string" } } }, "buttonsConfiguration": { "type": "object", "properties": {} }, "headerFormulaName": { "type": "string" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "matrixFormulaName": { "type": "string" }, "matrixFormulaElementName": { "type": "string" }, "customActionLogics": { "type": "string" }, "contextualActions": { "type": "object", "properties": {} }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "id": { "type": "integer" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "targetDate": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "userGroupCanUseType": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "elementNames": { "type": "array", "items": { "type": "string" } }, "dynamicItemMode": { "type": "string" }, "resultElementName": { "type": "string" } } }, "buttonsConfiguration": { "type": "object", "properties": {} }, "headerFormulaName": { "type": "string" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "matrixFormulaName": { "type": "string" }, "matrixFormulaElementName": { "type": "string" }, "customActionLogics": { "type": "string" }, "contextualActions": { "type": "object", "properties": {} }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "id": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "operationType": "update", "textMatchStyle": "exact", "data": { "typedId": "7.PGTT", "uniqueName": "Simple Price Grid Type 1 - New Name", "label": "Simple Price Grid Type 1 Label", "createdByName": "john.doe", "lastUpdateByName": "john.doe", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice" ], "dynamicItemMode": "ADD_ONLY", "resultElementName": "resultPrice" }, "buttonsConfiguration": {}, "headerFormulaName": "Header Formula", "dimensionType": "SIMPLE", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element", "customActionLogics": "{key1=value}", "contextualActions": {}, "createDate": "2024-10-08T12:21:41", "createdBy": 2147492568, "lastUpdateDate": "2024-10-08T12:21:41", "lastUpdateBy": 2147492568, "id": 7 }, "oldValues": { "version": 0, "typedId": "7.PGTT", "uniqueName": "Simple Price Grid Type 1", "label": "Simple Price Grid Type 1 Label", "createdByName": "john.doe", "lastUpdateByName": "john.doe", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice" ], "dynamicItemMode": "ADD_ONLY", "resultElementName": "resultPrice" }, "buttonsConfiguration": {}, "headerFormulaName": "Header Formula", "dimensionType": "SIMPLE", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element", "customActionLogics": "{key1=value}", "contextualActions": {}, "createDate": "2024-10-08T12:21:41", "createdBy": 2147492568, "lastUpdateDate": "2024-10-08T12:21:41", "lastUpdateBy": 2147492568, "id": 7 } } } } } } } } }, "/update/PLTT": { "post": { "summary": "Update a Price List Type", "tags": [ "Price Lists" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListType" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 1, "typedId": "2.PLTT", "uniqueName": "New Name for Price List Type 2", "label": "Price List Type 1 Label", "createdByName": "john.doe", "lastUpdateByName": "john.doe", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice" ], "resultElementName": "resultPrice", "shotgunModeEnabled": true }, "buttonsConfiguration": {}, "headerFormulaName": "Header Formula", "dimensionType": "SIMPLE", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element", "customActionLogics": "{key1=value}", "contextualActions": {}, "createDate": "2024-09-09T15:51:55", "createdBy": 2147492568, "lastUpdateDate": "2024-09-09T15:55:29", "lastUpdateBy": 2147492568, "id": 2 } ], "status": 0 } } } } } } } }, "operationId": "post-update-PLTT", "description": "Updates the Price List Type.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operationType": { "type": "string" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "targetDate": { "type": "string" }, "userGroupEdit": { "type": "string" }, "userGroupViewDetails": { "type": "string" }, "userGroupCanUseType": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "elementNames": { "type": "array", "items": { "type": "string" } }, "resultElementName": { "type": "string" }, "shotgunModeEnabled": { "type": "boolean" } } }, "buttonsConfiguration": { "type": "object", "properties": {} }, "headerFormulaName": { "type": "string" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "matrixFormulaName": { "type": "string" }, "matrixFormulaElementName": { "type": "string" }, "customActionLogics": { "type": "string" }, "contextualActions": { "type": "object", "properties": {} }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "id": { "type": "integer" } } }, "oldValues": { "type": "object", "properties": { "version": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "operationType": "update", "textMatchStyle": "exact", "data": { "version": 0, "typedId": "2.PLTT", "uniqueName": "New Name for Price List Type 2", "label": "Price List Type 1 Label", "createdByName": "john.doe", "lastUpdateByName": "john.doe", "targetDate": "2030-01-01", "userGroupEdit": "Group B", "userGroupViewDetails": "Group A", "userGroupCanUseType": "Group C", "typeConfiguration": { "elementNames": [ "testFormula", "ElementB", "resultPrice" ], "resultElementName": "resultPrice", "shotgunModeEnabled": true }, "buttonsConfiguration": {}, "headerFormulaName": "Header Formula", "dimensionType": "SIMPLE", "calculationFormulaName": "Formula A", "matrixFormulaName": "Matrix Keys Generation Formula", "matrixFormulaElementName": "Element", "customActionLogics": "{\"key1\": \"value\"}", "contextualActions": {}, "createDate": "2024-09-09T15:51:55", "createdBy": 2147492568, "lastUpdateDate": "2024-09-09T15:51:55", "lastUpdateBy": 2147492568, "id": 2 }, "oldValues": { "version": 0 } } } } } } } } }, "/pricegridmanager.fetchxls/{id1}/{id2}/{id3}/{id4}/{id5}/{id6}/{id7}/{id8}/{id9}/{id10}/{id11}/{id12}/{id13}": { "get": { "summary": "Download a Live Price Grid Excel File", "tags": [ "Live Price Grids" ], "operationId": "get-pricegridmanager.fetchxls", "description": "Downloads the specified Price Grid in the XLSX format.", "parameters": [ { "schema": { "type": "string" }, "name": "id1", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id2", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id3", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id4", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id5", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id6", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id7", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id8", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id9", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id10", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id11", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id12", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id13", "in": "path", "required": true, "style": "simple", "explode": false, "description": "IDs of the Price Grids you want to download." }, { "$ref": "#/components/parameters/templateName" } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "type": "string", "format": "binary" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "id1", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id2", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id3", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id4", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id5", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id6", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id7", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id8", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id9", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id10", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id11", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id12", "in": "path", "required": true }, { "schema": { "type": "string" }, "name": "id13", "in": "path", "required": true } ] }, "/productmanager.fetchpxam": { "post": { "summary": "Get Product Attribute Meta", "operationId": "post-productmanager.fetchpxam", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductExtensionAttributeMeta" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7bcc977f5c-h5m76", "startRow": 0, "data": [ { "version": 0, "typedId": "283.PXAM", "fieldName": "attribute1", "label": "StringAttribute", "fieldType": 2, "requiredField": false, "readOnly": false, "labelTranslations": "{\n \"\":\"String\"\n}", "name": "TEST", "createDate": "2021-03-18T16:36:05", "createdBy": 2147483667, "lastUpdateDate": "2021-03-18T16:36:05", "lastUpdateBy": 2147483667 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Product Extensions" ], "description": "Extended fetch command to retrieve product attribute meta data.

\nUnlike the general `fetch/{typeCode}` endpoint, this extended endpoint also handles global metadata configurations.
\nFor example, if product metadata is configured to originate from the global partition, this command will automatically retrieve it from there. In contrast, the general fetch endpoint is limited to returning data exclusively from the local partition.", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/importmanager.upload/{slotId}/{typeCode}/{target}": { "parameters": [ { "schema": { "type": "string", "enum": [ "P", "PX" ] }, "name": "typeCode", "in": "path", "required": true, "description": "Target object type code." }, { "schema": { "type": "string" }, "name": "target", "in": "path", "description": "Provides additional details about the target object, such as specifying a PX name if required.", "required": true }, { "schema": { "type": "string" }, "name": "slotId", "in": "path", "required": true, "description": "ID of the Upload Slot." } ], "post": { "summary": "Upload Excel to Import Manager", "operationId": "post-importmanager.upload-(slotId)-typeCode-target", "responses": { "200": { "description": "File uploaded successfully.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportManager" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-b6fcc5bb8-9pmxh", "data": [ { "version": 7, "typedId": "2.IM", "uniqueName": "IM-2", "label": "New Import", "ownerUN": "admin", "approvalState": "NOT_APPROVED", "approvalDate": null, "createdByName": "admin", "lastUpdateByName": "admin", "submittedByName": null, "workflowStatus": "DRAFT", "workflowFormulaName": null, "status": "CHANGE_DETECTION", "targetObject": "P", "targetSpecifics": null, "importOptions": null, "deniedByName": null, "approvedByName": null, "approvalRequiredEmailAttachments": [], "createDate": "2025-01-24T14:37:45", "createdBy": 2147490696, "lastUpdateDate": "2025-01-24T14:48:56", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } }, "400": { "description": "Invalid parameters or slot ID not found." }, "415": { "description": "Unsupported file type uploaded." } }, "tags": [ "Imports" ], "description": "Uploads an Excel file to a specific import via the upload slot created by `/uploadmanager.newuploadslot`. Use the optional `managerUN` query parameter to specify the unique name of the Import Manager.
\nThe maximum file size: 1GB\n", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "managerUN", "description": "Unique name of the Import Manager in case you are re-uploading the file." } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } } } } }, "/importmanager.fetchchanges/{uniqueName}": { "parameters": [ { "schema": { "type": "string" }, "name": "uniqueName", "in": "path", "required": true } ], "post": { "summary": "List ImportManager Changes", "operationId": "post-importmanager.fetchchanges-uniqueName", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportChange" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } } } } } }, "description": "Retrieves all, or filtered, changes for the specified ImportManager.", "tags": [ "Imports" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/importmanager.deletechanges": { "post": { "summary": "Delete Import Changes", "operationId": "post-importmanager.deletechanges", "responses": { "200": { "$ref": "#/components/responses/generalResponse" } }, "tags": [ "Imports" ], "description": "Reverts all changes specified in the request body.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedIds": { "type": "array", "description": "Array of typedIds of import changes you want to delete.", "items": { "type": "string" } } } } } } } } } } }, "/importmanager.savechange": { "post": { "summary": "Save Import Change", "operationId": "post-importmanager.savechange", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportChange" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6fbd966b7f-kc8h2", "data": [ { "version": 0, "typedId": "5.IMC", "managerUN": "IM-3", "typeOfChange": "DELETE", "columnName": null, "originalValue": null, "value": null, "targetPrimaryKeys": { "sku": "B-0003" }, "validationErrors": null, "createDate": "2025-02-05T15:28:05", "createdBy": 2147490696, "lastUpdateDate": "2025-02-05T15:28:05", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "description": "Saves or updates an Import Change identified by Import Manager uniquename, type of change, target column name, target primary keys.", "tags": [ "Imports" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Example 1": { "value": { "data": { "managerUN": "IM-3", "targetPrimaryKeys": { "sku": "B-0003" }, "typeOfChange": "DELETE" } } } } } } } } }, "/importmanager.submit/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "123.I" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the import" } ], "post": { "summary": "Submit Changes", "operationId": "post-importmanager.submit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportManager" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-7b79967489-zfwj4", "data": [ { "version": 3, "typedId": "2.IM", "uniqueName": "IM-2", "label": "New Import", "ownerUN": "admin", "approvalState": "APPROVED", "approvalDate": null, "createdByName": "admin", "lastUpdateByName": "admin", "submittedByName": null, "workflowStatus": "APPROVED", "workflowFormulaName": null, "status": "IN_PROGRESS", "targetObject": "P", "targetSpecifics": null, "importOptions": { "includeNewRows": false, "includeDeletedRows": false, "includeUpdatedRows": true }, "deniedByName": null, "approvedByName": null, "approvalRequiredEmailAttachments": [], "createDate": "2025-02-13T11:44:17", "createdBy": 2147490696, "lastUpdateDate": "2025-02-13T11:44:56", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Imports" ], "description": "Writes the changes made by the user in the Import Manager to the database. The changes are subject to validation against the data in the database. All the changes must pass the validation for the submit to be successful.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "importOptions": { "type": "object", "properties": { "includeNewRows": { "type": "boolean" }, "includeUpdatedRows": { "type": "boolean" }, "includeDeletedRows": { "type": "boolean" } } } } } } } } } } } }, "/review.update/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the object to update." } ], "post": { "summary": "Update a Review Status", "operationId": "post-review.update-typedId", "responses": { "200": { "$ref": "#/components/responses/generalResponse" }, "400": { "description": "Invalid request." }, "403": { "description": "Forbidden - User does not have access rights to perform this action." }, "423": { "description": "The object is locked and cannot be modified." } }, "description": "> **This feature is experimental in version 14.0 - Caribou Lou.**\n

\nUpdates the review status of the specified line items in the Review step of the Collaboration Workflow. The request can only be executed by a member of the User Group that is currently authorized to review the associated input fields, as defined in the Creation Workflow configuration. If the user does not have the required permissions, the request will fail.", "tags": [ "Workflow" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/review.done/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the object to mark as reviewed." } ], "post": { "summary": "Set a Review as Done", "operationId": "post-review.done-typedId", "responses": { "200": { "description": "Review successfully marked as done." }, "403": { "description": "Forbidden - User does not have access rights to perform this action." }, "423": { "description": "The object is locked and cannot be reviewed." } }, "description": "> **This feature is experimental in version 14.0 - Caribou Lou.**\n

\nCompletes the review of line items in the Review step of the Collaboration workflow. Only members of the User Group currently authorized by the Creation Workflow configuration can execute this request; otherwise, the request will fail.\n", "tags": [ "Workflow" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } } } }, "/commentmanager.add": { "post": { "summary": "Add a Comment", "operationId": "post-commentmanager.add", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommentThread" } }, "status": { "type": "integer" } } } } } } } } }, "tags": [ "Comments" ], "description": "Adds a comment to the specified object.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "`typedId of the object to which you want to add a comment.", "properties": { "parentObjectIdentifier": { "type": "string" }, "relatedObjectIdentifier": { "type": "array", "description": "set of lineIds", "items": { "type": "string" } }, "body": { "type": "string", "description": "The text content of the comment." } } } } } } } } } }, "/commentmanager.reply": { "post": { "summary": "Reply To a Comment", "operationId": "post-commentmanager.reply", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommentThread" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "node", "data": [ { "version": 0, "typedId": "12.CMTRD", "relatedObjects": [ "bZWNHIYllshAzzR" ], "comments": [ { "version": 0, "typedId": "16.CMNT", "body": "10 comment", "createDate": "2024-10-15T12:42:50", "createdBy": 2147490698, "lastUpdateDate": "2024-10-15T12:42:50", "lastUpdateBy": 2147490698 }, { "version": 0, "typedId": "17.CMNT", "body": "A comment reply", "createDate": "2024-10-15T12:47:24", "createdBy": 2147490698, "lastUpdateDate": "2024-10-15T12:47:24", "lastUpdateBy": 2147490698 } ], "resolved": false, "createDate": "2024-10-15T12:42:44", "createdBy": 2147490698, "lastUpdateDate": "2024-10-15T12:42:44", "lastUpdateBy": 2147490698 } ], "status": 0 } } } } } } } }, "tags": [ "Comments" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "commentThreadTypedId": { "type": "string" }, "body": { "type": "string" } } } } } } } }, "description": "Posts a reply to the comment specified by the `commentThreadTypedId` in the request body." } }, "/commentmanager.delete/{typedId}": { "post": { "summary": "Delete a Comment", "operationId": "post-commentmanager.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "deletedItem": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "node", "data": [ { "deletedItem": "17.CMNT" } ], "status": 0 } } } } } } } }, "tags": [ "Comments" ], "description": "Deletes an existing Comment or CommentThread.
\nIf the CommentThread contains only one comment, the whole CommentThread is deleted.
\nIf the CommentThread is deleted, all related Comments are hard deleted." }, "parameters": [ { "schema": { "type": "string", "example": "12.CMTRD" }, "name": "typedId", "in": "path", "required": true, "description": "Comment or CommentThread typedId" } ] }, "/commentmanager.fetchthreads/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147494376.Q" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the object you want to fetch comments for." } ], "post": { "summary": "List Comment Threads", "operationId": "post-commentmanager.fetchthreads-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "startRow": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommentThread" } }, "endRow": { "type": "integer" }, "totalRows": { "type": "integer" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "node", "startRow": 0, "data": [ { "version": 0, "typedId": "13.CMTRD", "relatedObjects": [ "bZWNHIYllshAzzR" ], "comments": [ { "version": 0, "typedId": "18.CMNT", "body": "10 comment", "createDate": "2024-10-15T12:56:52", "createdBy": 2147490698, "lastUpdateDate": "2024-10-15T12:56:52", "lastUpdateBy": 2147490698 } ], "resolved": false, "createDate": "2024-10-15T12:56:52", "createdBy": 2147490698, "lastUpdateDate": "2024-10-15T12:56:52", "lastUpdateBy": 2147490698 } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } } }, "tags": [ "Comments" ], "description": "Retrieves comment threads associated with the specified object. An empty request body returns all comment threads. To narrow down returned comment threads, employ a filter in the request body (see the request example).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "sortBy": { "type": "array", "items": { "type": "string" } }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "operator": { "type": "string" }, "_constructor": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "Example 1": { "value": { "endRow": 2000, "oldValues": null, "operationType": "fetch", "startRow": 0, "sortBy": [ "-createDate" ], "textMatchStyle": "exact", "data": { "operator": "and", "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "relations.relatedObjectIdentifier", "operator": "equals", "value": "bZWNHIYllshAzzR" } ] } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "getMyComments", "description": "`true` - get only comments for \"Items for Review\" section
`false` - get \"Other Items\" section
`null` - get all comments" } ] } }, "/commentmanager.resolve/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The typedId of the comment thread." } ], "post": { "summary": "Resolve a Comment", "operationId": "post-commentmanager.resolve-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/CommentThread" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": { "typedId": "9.CMTRD", "comments": [ { "typedId": "12.CMNT", "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "body": "Comment 1", "version": 0, "createDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0 } ], "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "version": 0, "relatedObjects": [ "EN78TIdBeIgpde9" ], "resolved": true, "createDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0 }, "status": 0 } } } } } } } }, "tags": [ "Comments" ], "description": "Resolves a comment thread.", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/commentmanager.unresolve/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "The typedId of the comment thread." } ], "post": { "summary": "Unresolve a Comment", "operationId": "post-commentmanager.unresolve-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "$ref": "#/components/schemas/CommentThread" }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend", "data": { "typedId": "9.CMTRD", "comments": [ { "typedId": "12.CMNT", "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "body": "Comment 1", "version": 0, "createDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0 } ], "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "version": 0, "relatedObjects": [ "EN78TIdBeIgpde9" ], "resolved": true, "createDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0 }, "status": 0 } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "tags": [ "Comments" ], "description": "Unresolves a previously resolved comment thread." } }, "/commentmanager.edit/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "12.CMNT" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the comment you want to edit." } ], "post": { "summary": "Edit a Comment", "operationId": "post-commentmanager.edit-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommentThread" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster-app-frontend-6cbbff95d-th6wz", "data": [ { "version": 2, "typedId": "2.CMTRD", "relatedObjects": [ "KpOpdPpPhm8IQL1" ], "comments": [ { "version": 1, "typedId": "2.CMNT", "body": "an edited comment", "createDate": "2025-02-28T11:02:57", "createdBy": 2147490696, "lastUpdateDate": "2025-02-28T11:03:12", "lastUpdateBy": 2147490696 } ], "resolved": false, "createDate": "2025-02-28T11:02:57", "createdBy": 2147490696, "lastUpdateDate": "2025-02-28T11:03:12", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "tags": [ "Comments" ], "description": "Edits the comment specified as the path param. Replaces the comment with the text provided in the request body.
\nWith each edit, the version number is incremented by 1. The comment metadata includes timestamps for creation and last update, along with the author of each change. If a reply is added to a resolved thread, the thread automatically changes to an unresolved state.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "body": { "type": "string", "description": "Specify the new text content of the comm" } } } } }, "examples": { "Example 1": { "value": { "data": { "body": "an edited comment" } } } } } } } } }, "/review.fetchpendingreviews": { "post": { "summary": "Fetch Pending Reviews", "operationId": "post-review.fetchpendingreviews", "responses": { "200": { "description": "OK" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "userGroupName": { "type": "string" }, "stepLabel": { "type": "string" }, "subStepLabel": { "type": "string" }, "documentUniqueName": { "type": "string" }, "documentLabel": { "type": "string" }, "liGroupName": { "type": "string" }, "documentTypedId": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster", "data": [ { "userGroupName": "PricingManagers", "stepLabel": "Review Quote Items", "subStepLabel": "Pricing Management Review", "documentUniqueName": "P-2158463", "documentLabel": "New Quote", "liGroupName": "EMEA", "documentTypedId": "2158463.Q" } ], "status": 0 } } } } } } } }, "description": "Fetches a list of pending collaboration workflow reviews for the current user.", "tags": [ "Workflow" ] } }, "/clicmanager.folderstats/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "2147494.Q" }, "name": "typedId", "in": "path", "required": true, "description": "typedId of the document whose folder statistics you want to fetch." } ], "post": { "summary": "Get Folder Statistics", "operationId": "post-clicmanager.folderstats-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "FolderID": { "type": "integer" }, "ROOT": { "type": "integer" }, "execution time": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "node": "pricefx-cluster", "data": [ { "iZOp5XIIUofGWq5": 2, "ROOT": 2, "cYK7qJRcnCoT4Q2": 1, "execution time": "23ms" } ], "status": 0 } } } } } } } }, "description": "Returns a list of parent IDs with the count of nested items. An example can be a list of Quote folders (their IDs) with the count of line items inside them.", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "withLineIds", "description": "If set to true, returns a list of line item IDs inside the folders instead of their count." } ], "tags": [ "Quotes", "Clicmanager" ] } }, "/optimization.modelimport": { "post": { "summary": "Import Models", "operationId": "post-optimization.modelimport", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ModelObject" } }, "status": { "type": "integer" } } } } } } } }, "400": { "description": "Bad request (e.g. missing or invalid file)" }, "500": { "description": "Internal Server Error" } }, "tags": [ "Optimization" ], "description": "Imports a previously exported model from a ZIP file.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "ZIP file containing one or more JSON model files" } } } } } } } }, "/optimization.modelexport": { "post": { "summary": "Export Models", "operationId": "post-optimization.modelexport", "responses": { "200": { "description": "OK - A ZIP file containing the exported model JSON files.", "content": { "application/zip": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad request (e.g. incorrect path or missing typedIds)" }, "403": { "description": "Permission denied for one or more models" }, "404": { "description": "One or more model IDs not found or missing typedIds" }, "500": { "description": "Internal Server Error" } }, "tags": [ "Optimization" ], "description": "Export models to a ZIP file.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "typedIds": { "type": "array", "description": "List of model typedIds to export (e.g. \"1.MO\", \"2.MO\")", "items": { "type": "string" } } } } } }, "examples": { "Example 1": { "value": { "data": { "typedIds": [ "1.MO", "2.MO" ] } } } } } } } }, "parameters": [] }, "/datamart.loadfc/{typedId}": { "parameters": [ { "schema": { "type": "string", "example": "12.DMDS" }, "name": "typedId", "in": "path", "required": true, "description": "Specifies the typedId (format: `{id}.{type}`) of the FieldCollection to load data into. Type must be either `DMDS` or `DMT`." } ], "post": { "summary": "Load Data Into FieldCollection", "operationId": "post-datamart.loadfc-typedId", "responses": { "200": { "description": "OK - data loaded successfully into the DMFieldCollection." }, "400": { "description": "Bad Request - Invalid typedId, FieldCollection not found, or AVRO processing error." }, "401": { "description": "Unauthorized" }, "500": { "description": "Internal Server Error" } }, "tags": [ "Optimization" ], "description": "Loads AVRO data into a DMFieldCollection (DMDS or DMT) from a multipart/form-data request.

\nIt fails if the specified FieldCollection does not exist. Duplicate key values are forbidden. Type checking and schema validation are enforced.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fcData": { "type": "string", "format": "binary", "description": "AVRO file containing the data to load." } } } } } } } }, "/datamart.deleteobsoletes": { "post": { "summary": "List Datamart Orphan Objects", "tags": [ "Data Manager" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "dmtsWithMissingOwner": { "type": "object" }, "dlsWithMissingTarget": { "type": "object" }, "orphanPaDbTables": { "type": "object" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "dmtsWithMissingOwner": { "seeddata.DMT.Segmentation_2147484118_DMDL.1": "Not deleted (in dry-run mode)", "seeddata.DMT.Segmentation_2147484519_DMDL.2": "Not deleted (in dry-run mode)", "seeddata.DMT.Segm_Godfather_2147484637_DMDL.3": "Not deleted (in dry-run mode)", "seeddata.DMT.Segm_Bijou_2147484639_DMDL.5": "Not deleted (in dry-run mode)", "seeddata.DMT.Segm_Bijou_2147484647_DMDL.6": "Not deleted (in dry-run mode)", "seeddata.DMT.Segm_Godfather_2147484649_DMDL.7": "Not deleted (in dry-run mode)", "seeddata.DMT.Segm_Bijou_2147484653_DMDL.11": "Not deleted (in dry-run mode)", "seeddata.DMT.Seg_Bijou_2147484655_DMDL.12": "Not deleted (in dry-run mode)" }, "dlsWithMissingTarget": {}, "orphanPaDbTables": { "seeddata_DM_GDPvsLifeExpectancy": "Not deleted (in dry-run mode)", "seeddata_DM_Simple": "Not deleted (in dry-run mode)", "seeddata_DM_Simple12": "Not deleted (in dry-run mode)", "seeddata_DM_Simple13": "Not deleted (in dry-run mode)" } } ], "status": 0 } } } } } } } }, "operationId": "post-datamart.deleteobsoletes", "description": "Returns a list of orphan Datamart objects. Identifies and returns details about objects considered obsolete. Objects such as:\n\n- Datamart Tables with missing owners.\n- Data Loads for which the target Field Cache was deleted.\n- Analytics (PriceAnalyzer) tables without a matching deployed Field Cache (FC).\n\nBy default this endpoint works in the `dry run` mode to mitigate accidental deletions. Actual deletions require adding explicit `/delete` in the endpoint URL." } }, "/datamart.deleteobsoletes/delete": { "post": { "summary": "Delete Datamart Orphan Objects", "tags": [ "Data Manager" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "dmtsWithMissingOwner": { "type": "object" }, "dlsWithMissingTarget": { "type": "object" }, "orphanPaDbTables": { "type": "object" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "dmtsWithMissingOwner": { "seeddata.DMT.Segmentation_2147484118_DMDL.1": "Deleted", "seeddata.DMT.Segmentation_2147484519_DMDL.2": "Deleted", "seeddata.DMT.Segm_Godfather_2147484637_DMDL.3": "Deleted", "seeddata.DMT.Segm_Bijou_2147484639_DMDL.5": "Deleted", "seeddata.DMT.Segm_Bijou_2147484647_DMDL.6": "Deleted", "seeddata.DMT.Segm_Godfather_2147484649_DMDL.7": "Deleted", "seeddata.DMT.Segm_Bijou_2147484653_DMDL.11": "Deleted", "seeddata.DMT.Seg_Bijou_2147484655_DMDL.12": "Deleted" }, "dlsWithMissingTarget": {}, "orphanPaDbTables": { "seeddata_DM_GDPvsLifeExpectancy": "Deleted", "seeddata_DM_Simple": "Deleted", "seeddata_DM_Simple12": "Deleted", "seeddata_DM_Simple13": "Deleted" } } ], "status": 0 } } } } } } } }, "operationId": "post-datamart.deleteobsoletes-delete", "description": "Deletes orphan Datamart objects. Identifies and deletes objects considered obsolete. Objects such as:\n\n- Datamart Tables with missing owners.\n- Data Loads for which the target Field Cache was deleted.\n- Analytics (PriceAnalyzer) tables without a matching deployed Field Cache (FC)." } }, "/activitylog.fetch": { "post": { "summary": "Fetch Activities", "operationId": "post-activitylog.fetch", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "operationType": { "type": "string" }, "objType": { "type": "string" }, "objId": { "type": "integer" }, "createdByName": { "type": "string" }, "objLabel": { "type": "string" }, "createDate": { "type": "string" } } } } } }, "examples": { "Example 1": { "value": { "data": [ { "operationType": "CREATE", "objType": "Q", "objId": 2147494441, "createdByName": "admin", "objLabel": "New Quote", "createDate": "2025-08-28T05:53:04" }, { "operationType": "SUBMIT", "objType": "Q", "objId": 2147494441, "createdByName": "admin", "createDate": "2025-08-28T05:53:26" }, { "operationType": "WORKFLOW_STEP_APPROVED", "objType": "Q", "objId": 2147494441, "createdByName": "admin", "createDate": "2025-08-28T05:53:33" }, { "operationType": "WORKFLOW_REJECTED", "objType": "Q", "objId": 2147494441, "createdByName": "admin", "createDate": "2025-08-28T05:53:36" } ] } } } } } } }, "description": "Fetches activities for a CLIC module activity log in a concise format, e.g., when multiple 'add item' actions are performed consecutively, they are consolidated into a single activity log entry containing all details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "string" }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" }, "_constructor": { "type": "string" } } } } } } } } }, "sortBy": { "type": "array", "items": { "type": "string" } } } }, "examples": { "Example 1": { "value": { "endRow": 0, "oldValues": "string", "operationType": "string", "startRow": 0, "textMatchStyle": "string", "data": { "_constructor": "string", "operator": "string", "criteria": [ { "_constructor": "string", "operator": "string", "criteria": [ { "fieldName": "string", "operator": "string", "value": "string", "_constructor": "string" } ] } ] }, "sortBy": [ "string" ] } } } } } }, "tags": [ "Clicmanager" ] } }, "/oauth/authorize": { "post": { "summary": "OAuth Authorization Request", "operationId": "post-oauth-authorize", "responses": { "302": { "description": "Found", "headers": {} } }, "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "response_type", "description": "Value MUST be set to \"code\".", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "client_id", "description": "The client identifier.", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "redirect_uri", "description": "The URL to redirect to after authorization has been granted." }, { "schema": { "type": "string" }, "in": "query", "name": "scope", "description": "The scope of the access request." }, { "schema": { "type": "string" }, "in": "query", "name": "state", "description": "An opaque value used by the client to maintain state between the request and callback." } ], "description": "The authorization endpoint is used to interact with the resource owner and obtain an authorization grant. See https://datatracker.ietf.org/doc/html/rfc6749#section-3.1 for details. At the end of the flow it will send a code value back to/via the redirecttion URL specified in the client’s config & initial request (as they need to be the same).\n", "tags": [ "Authentication" ] }, "parameters": [] }, "/oauth/token": { "post": { "summary": "Access Token Request", "operationId": "post-oauth-token", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer" }, "refresh_token": { "type": "string" }, "example_parameter": { "type": "string" } } }, "examples": { "Example 1": { "value": { "access_token": "2YotnFZFEjr1zCsicMWpAA", "token_type": "bearer", "expires_in": 7200, "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter": "example_value" } } } } } } }, "description": "Request to obtain the access token in the OAuth authorization process. See https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.3 for details.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "grant_type", "description": "Value MUST be set to \"authorization_code\".", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "code", "description": "The authorization code received from the authorization server.", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "redirect_uri", "description": "Required if the \"redirect_uri\" parameter was included in the authorization request and their values MUST be identical." }, { "schema": { "type": "string" }, "in": "query", "name": "client_id", "description": "Required if the client is not authenticating with the authorization server." } ], "tags": [ "Authentication" ] } }, "/formulamanager.executelibraryfunction/{formulaName}/{elementName}/{functionName}": { "post": { "summary": "Execute Library Function", "operationId": "post-formulamanager.executelibraryfunction", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad request. Validation or execution error. Possible causes:\n- Missing or invalid path segments\n- Library formula not found\n- Formula exists but not of type LIBRARY\n- Library element not found within the logic\n- `allowObjectMods` has wrong type (must be a boolean)\n- `functionArgs` must be an array/list\n- An exception occurred during function execution" }, "401": { "description": "Unauthorized. Authentication required or failed." }, "403": { "description": "Forbidden. Insufficient permissions. Requires PRICINGFORMULA_EXECUTE" }, "500": { "description": "Internal Server Error" } }, "tags": [ "Logics" ], "description": "Executes a specific function from a **formula library element** without requiring a full formula logic implementation.
\nParameters are provided via the request payload and the calculated result is returned.

\n>**Note**:\n>- This endpoint **does not** work with `inputs` bindings. Provide ordered function arguments instead.\n>- Used by the **Pricefx MCP server** to enable Groovy-configured MCP Tools.\n>- Requires the `PRICINGFORMULA_EXECUTE` permission.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "allowObjectMods": { "type": "boolean", "description": "Specifies whether the logic may internally perform modifications. Defaults to **false**." }, "functionArgs": { "type": "array", "description": "An array of input arguments, that will be passed in order to the function call. Note, do not provide the parameter names, only the ordered literal values you want passed in.", "items": {} } } } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "name": "formulaName", "in": "path", "required": true, "description": "Name of the formula library containing the function." }, { "schema": { "type": "string" }, "name": "elementName", "in": "path", "required": true, "description": "Name of the library element containing the function." }, { "schema": { "type": "string" }, "name": "functionName", "in": "path", "required": true, "description": "Name of the function to execute." } ] }, "/importmanager.massedit/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Mass Edit Imports", "operationId": "post-importmanager.massedit-typedId", "responses": { "200": { "description": "OK" }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "managerUN": { "type": "string" }, "typeOfChange": { "type": "string" }, "columnName": { "type": "string" }, "originalValue": { "type": "string", "nullable": true }, "value": { "type": "object", "properties": { "attribute18": { "type": "string" } } }, "targetPrimaryKeys": { "type": "object", "properties": { "sku": { "type": "string" } } }, "validationErrors": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "string" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "5796.IMC", "managerUN": "IM-6", "typeOfChange": "UPDATE", "columnName": "attribute18", "originalValue": null, "value": { "attribute18": "A" }, "targetPrimaryKeys": { "sku": "B-0014" }, "validationErrors": null, "createDate": "2025-11-05T12:40:20", "createdBy": "admin", "lastUpdateDate": "2025-11-05T12:40:20", "lastUpdateBy": "admin" }, { "version": 0, "typedId": "5797.IMC", "managerUN": "IM-6", "typeOfChange": "UPDATE", "columnName": "attribute18", "originalValue": null, "value": { "attribute18": "A" }, "targetPrimaryKeys": { "sku": "B-0069" }, "validationErrors": null, "createDate": "2025-11-05T12:40:20", "createdBy": "admin", "lastUpdateDate": "2025-11-05T12:40:20", "lastUpdateBy": "admin" }, { "version": 0, "typedId": "5798.IMC", "managerUN": "IM-6", "typeOfChange": "UPDATE", "columnName": "attribute18", "originalValue": null, "value": { "attribute18": "A" }, "targetPrimaryKeys": { "sku": "B-0084" }, "validationErrors": null, "createDate": "2025-11-05T12:40:20", "createdBy": "admin", "lastUpdateDate": "2025-11-05T12:40:20", "lastUpdateBy": "admin" }, { "version": 0, "typedId": "5799.IMC", "managerUN": "IM-6", "typeOfChange": "UPDATE", "columnName": "attribute18", "originalValue": null, "value": { "attribute18": "A" }, "targetPrimaryKeys": { "sku": "MB-0005" }, "validationErrors": null, "createDate": "2025-11-05T12:40:20", "createdBy": "admin", "lastUpdateDate": "2025-11-05T12:40:20", "lastUpdateBy": "admin" }, { "version": 0, "typedId": "5800.IMC", "managerUN": "IM-6", "typeOfChange": "UPDATE", "columnName": "attribute18", "originalValue": null, "value": { "attribute18": "A" }, "targetPrimaryKeys": { "sku": "MB-0006" }, "validationErrors": null, "createDate": "2025-11-05T12:40:20", "createdBy": "admin", "lastUpdateDate": "2025-11-05T12:40:20", "lastUpdateBy": "admin" } ], "status": 0 } } } } } } } }, "description": "Mass updates changes in Import Manager.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "array", "items": { "type": "integer" } }, "_constructor": { "type": "string" } } } } } }, "massEditRecords": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "massEditOperator": { "type": "string" }, "fieldValue": { "type": "string" }, "precision": { "type": "integer" } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "filterCriteria": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "id", "operator": "inSet", "value": [ 2147484135, 2147484190, 2147484205, 2147484225, 2147484226 ], "_constructor": "AdvancedCriteria" } ] }, "massEditRecords": [ { "fieldName": "attribute18", "massEditOperator": "=", "fieldValue": "A", "precision": 1 } ] } } } } } } }, "tags": [ "Imports" ] } }, "/importmanager.massdelete/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Mass Delete Imports", "operationId": "post-importmanager.massdelete-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "managerUN": { "type": "string" }, "typeOfChange": { "type": "string" }, "columnName": { "type": "string", "nullable": true }, "originalValue": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "targetPrimaryKeys": { "type": "object", "properties": { "sku": { "type": "string" } } }, "validationErrors": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "82.IMC", "managerUN": "IM-4", "typeOfChange": "DELETE", "columnName": null, "originalValue": null, "value": null, "targetPrimaryKeys": { "sku": "B-0029" }, "validationErrors": null, "createDate": "2025-11-06T11:31:50", "createdBy": 0, "lastUpdateDate": "string", "lastUpdateBy": 0 } ], "status": 0 } } } } } } } }, "tags": [ "Imports" ], "description": "Mass deletes changes in Import Manager.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "filterCriteria": { "type": "object", "properties": {} } } } } } } } } } }, "/quotemanager.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Quote Revocation", "operationId": "post-quotemanager.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "tags": [ "Quotes" ], "description": "Reverts the action 'Revoke Deal' and returns the Quote back to the Deal status. It is useful if the user revokes a Quote deal by mistake. There is no button for this action available in the UI." } }, "/contractmanager.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Agreement & Promotion Revocation", "operationId": "post-contractmanager.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "tags": [ "Contracts (Agreements & Promotions)" ], "description": "Reverts the action 'Revoke Agreement & Promotion' and returns the Agreement/Promotion back to the Approved status. It is useful if the user revokes an Agreement/Promotion by mistake. There is no button for this action available in the UI." } }, "/rebateagreement.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Rebate Agreement Revocation", "operationId": "post-rebateagreement.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "tags": [ "Rebate Agreements" ], "description": "Reverts the action 'Revoke Agreement' and returns the Rebate Agreement back to the Approved status. It is useful if the user revokes a Rebate Agreement by mistake. There is no button for this action available in the UI." } }, "/rebaterecordgroup.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Rebate Record Group Revocation", "operationId": "post-rebaterecordgroup.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "tags": [ "Rebate Record Group" ], "description": "Reverts the action 'Revoke' and returns the Rebate Record Group back to the Approved status. It is useful if the user revokes a Rebate Record Group by mistake. There is no button for this action available in the UI." } }, "/compensation.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Compensation Plan Revocation", "operationId": "post-compensation.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "tags": [ "Sales Compensations" ], "description": "Reverts the action 'Revoke Compensation Plan' and returns the Compensation Plan back to the Approved status. It is useful if the user revokes a Compensation Plan by mistake. There is no button for this action available in the UI." } }, "/rebaterecord.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Rebate Record Revocation", "operationId": "post-rebaterecord.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "description": "Reverts the action 'Revoke' and returns the Rebate Record back to the Approved status. It is useful if the user revokes a Rebate Record by mistake. There is no button for this action available in the UI.", "tags": [ "Rebate Agreements" ] } }, "/compensationrecord.undorevoke/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true } ], "post": { "summary": "Undo Compensation Record Revocation", "operationId": "post-compensationrecord.undorevoke-typedId", "responses": { "200": { "description": "OK" } }, "description": "Reverts the action 'Revoke' and returns the Compensation Record back to the Approved status. It is useful if the user revokes a Compensation Record by mistake. There is no button for this action available in the UI.", "tags": [ "Sales Compensations" ] } }, "/configurationmanager.get/{propertyname}": { "parameters": [ { "schema": { "type": "string" }, "name": "propertyname", "in": "path", "required": true, "description": "Name of the configuration property to retrieve." } ], "get": { "summary": "Get Advanced Configuration Property", "tags": [ "Advanced Configuration Options" ], "responses": { "200": { "description": "Property found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ "{\n \"datamartName\": \"Testing_Actin_Data\",\n \"productId\": \"ProductId\",\n \"productName\": \"label\",\n \"customerId\": \"CustomerId\",\n \"customerName\": \"name\",\n \"invoicePrice\": \"InvoicePrice\",\n \"quantity\": \"Quantity\",\n \"grossMargin\": \"GrossMargin\",\n \"costs\": \"ConsignmentCost\",\n \"pricingDate\": \"PricingDate\",\n \"productDimensions\": [\n \"ProductId\"\n ],\n \"customerDimensions\": [\n \"CustomerId\",\n \"CustomerGroup\"\n ],\n \"continent\": \"Region\",\n \"country\": \"Country\",\n \"localListPrice\": \"LocalListPrice\",\n \"globalListPrice\": \"GlobalListPrice\",\n \"netPrice\": \"NetPrice\",\n \"breakdownMode\": \"Standard\",\n \"firstDayOfWeek\": \"Sunday\"\n}" ], "status": 0 } } } } } } }, "404": { "description": "Property not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string", "nullable": true } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ null ], "status": 0 } } } } } } } }, "operationId": "get-configurationmanager-property", "description": "Returns the value of an Advanced Configuration Property by name." } }, "/queryapi.execute": { "post": { "summary": "Query API Execute", "tags": [ "General" ], "responses": { "200": { "description": "Successful execution.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "startRow": { "type": "integer" }, "data": { "type": "array", "nullable": true, "items": {} }, "endRow": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "startRow": 0, "data": [ [ "SC-001", "Seller 001", "grover", null, null, "grainger", null, "grover.grainger", "2025-12-11T08:01:40" ], [ "SC-002", "Seller 002", "tasnim", null, null, "levy", null, "tasnim.levy", "2025-12-11T08:01:40" ], [ "SC-003", "Seller 003", "aniela", null, null, "bauer", null, "aniela.bauer", "2025-12-11T08:01:40" ], [ "Seller 1", "Testing Seller A", null, null, null, null, null, null, "2025-12-11T08:01:40" ], [ "Seller 2", "Testing Seller B", "Test", null, "SC-001", null, null, "test", "2025-12-11T08:01:40" ], [ "Seller 3", "Testing Seller C", null, null, null, null, null, null, "2025-12-11T08:01:40" ], [ "Seller 4", "Testing Seller D", null, null, null, null, null, null, "2025-12-11T08:01:40" ], [ "Seller 5", "Testing Seller E", null, null, null, null, null, null, "2025-12-11T08:01:40" ], [ "Seller 6", "Testing Seller F", null, null, null, null, null, null, "2025-12-11T08:01:40" ] ], "endRow": 9 } } } } } } } }, "operationId": "post-queryapi.execute", "description": "Executes pipeline-based data Query API queries against the data sources and returns the resulting data rows.", "parameters": [ { "schema": { "type": "integer" }, "in": "query", "name": "timeout", "description": "Query timeout in seconds (default: 60, max: 300)." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "object", "properties": { "kind": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "table": { "type": "object", "properties": { "kind": { "type": "string" }, "dataSourceUniqueName": { "type": "string" } } } } } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "query": { "kind": "pipeline", "stages": [ { "kind": "source", "table": { "kind": "datasource", "dataSourceUniqueName": "Seller" } } ] } } } } } } } } } }, "/queryapi.meta": { "post": { "summary": "Get Query API Metadata", "tags": [ "General" ], "responses": { "200": { "description": "Metadata returned.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } } } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "columns": [ { "name": "sellerId", "type": "STRING" }, { "name": "name", "type": "STRING" }, { "name": "FirstName", "type": "STRING" }, { "name": "TerminationDate", "type": "DATE_ONLY" }, { "name": "reportsTo", "type": "STRING" }, { "name": "Surname", "type": "STRING" }, { "name": "isDeleted", "type": "BOOLEAN" }, { "name": "PricefxUserAccountId", "type": "STRING" }, { "name": "lastUpdateDate", "type": "DATE_TIME" } ] } ], "status": 0 } } } } } } } }, "operationId": "post-queryapi.meta", "description": "Returns metadata about sources:\n- Table kinds\n- Tables\n- Columns\n- Meta-descriptions\n- Columns of a given pipeline result", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "query": { "type": "object", "properties": { "kind": { "type": "string" }, "stages": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "table": { "type": "object", "properties": { "kind": { "type": "string" }, "dataSourceUniqueName": { "type": "string" } } } } } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "query": { "kind": "string", "stages": [ { "kind": "string", "table": { "kind": "string", "dataSourceUniqueName": "string" } } ] } } } } } } } } } }, "/uploadmanager.progress/{uploadslot}": { "parameters": [ { "schema": { "type": "string" }, "name": "uploadslot", "in": "path", "required": true, "description": "Upload Slot Id" } ], "post": { "summary": "Get Upload Progress", "tags": [ "Attachments" ], "responses": { "200": { "description": "The request response contains the current status of the upload slot, including progress information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "contentLength": { "type": "integer" }, "totalBytesRead": { "type": "integer" }, "status": { "type": "string" }, "data": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "percentage": { "type": "integer" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 3, "typedId": "5.US", "contentLength": 232, "totalBytesRead": 16, "status": "DONE", "data": null, "owner": null, "percentage": 6, "createDate": "2026-02-16T10:03:36", "createdBy": 2, "lastUpdateDate": "2026-02-16T10:04:58", "lastUpdateBy": 2 } ], "status": 0 } } } } } } } }, "operationId": "post-uploadmanager-progress", "description": "Returns current progress and status for a given upload slot.", "requestBody": { "content": {} } } }, "/bdmanager.edit/{ownerTypedId}/{binaryDataId}/{slot_id}": { "parameters": [ { "schema": { "type": "string" }, "name": "ownerTypedId", "in": "path", "required": true, "description": "The `TypedId` of the document owning the attachment." }, { "schema": { "type": "string" }, "name": "binaryDataId", "in": "path", "required": true, "description": "The `binaryDataId` of the attachment to replace." }, { "schema": { "type": "string" }, "name": "slot_id", "in": "path", "required": true, "description": "The upload `slot_id` containing the new file." } ], "post": { "summary": "2. Upload a File", "tags": [ "Attachments" ], "responses": { "200": { "description": "Attachment replaced.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "embeddedOwner": { "type": "string", "nullable": true }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "length": { "type": "integer" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string", "nullable": true }, "latestUploadStatusId": { "type": "integer" }, "sentViaEmail": { "type": "boolean" }, "sender": { "type": "string", "nullable": true }, "recipients": { "type": "string", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "version": 0, "typedId": "1139.BD", "embeddedOwner": null, "fileName": "DataExport-1649934421115.xlsx", "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "length": 55021, "userGroupEdit": null, "userGroupViewDetails": null, "createdByName": "admin", "lastUpdateByName": null, "latestUploadStatusId": 4296, "sentViaEmail": false, "sender": null, "recipients": null, "createDate": "2022-10-05T09:57:05", "createdBy": 2147490696, "lastUpdateDate": "2022-10-05T09:57:06", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } } }, "operationId": "post-bdmanager-edit", "description": "Replaces an existing attachment on a document with the file uploaded to the given upload slot. Mirrors `/bdmanager.upload` response shape.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "x-stoplight": { "id": "yypvjpvvy03en" }, "description": "A **base64** encoded file data.", "format": "binary" } } } } }, "description": "Optional direct file payload; if omitted, the file from the slot is used." } } }, "/optimization.updatejst": { "post": { "summary": "Update Job Status Tracker Entry", "tags": [ "Optimization" ], "responses": { "200": { "description": "JST updated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "typedId": { "type": "string" }, "status": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } }, "hasWarning": { "type": "boolean" } } } } } } } }, "examples": { "Example 1": { "value": { "response": { "status": 0, "data": [ { "id": 123456, "typedId": "JST123456", "status": "PROCESSING", "messages": [ "Using fallback constraint set for region EU" ], "hasWarning": false } ] } } } } } } } }, "operationId": "post-optimization-update-jst", "description": "Updates status, progress and optional diagnostic information for a Job Status Tracker entry. Used by Job Trigger and optimization engines.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jstId": { "type": "integer" }, "status": { "type": "string" }, "progress": { "type": "integer" }, "logEvents": { "type": "array", "items": { "type": "object", "properties": { "level": { "type": "string" }, "message": { "type": "string" } } } }, "calculationMessages": { "type": "array", "items": { "type": "string" } }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": {} } } } } } }, "examples": { "Example 1": { "value": { "data": { "jstId": 123456, "status": "PROCESSING", "progress": 35, "logEvents": [ { "level": "INFO", "message": "Started optimization phase 2/5" } ], "calculationMessages": [ "Using fallback constraint set for region EU" ], "calculationResults": [] } } } } } } } } }, "/genai.mcp/roles": { "post": { "summary": "Get MCP Roles", "tags": [ "MCP" ], "responses": { "200": { "description": "Roles received.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "MCP_role_datamart_details_fetcher": { "type": "string" }, "MCP_role_object_fetcher": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "MCP_role_datamart_details_fetcher": "{\n \"name\": \"Datamart Details Fetcher\",\n \"summary\": \"The Datamart Details Fetcher is in charge of fetching metadata information from Pricefx datamarts\",\n \"prompt\": \"\",\n \"available_tools\": [\n \"schema_analytics_get_datamart_details\"\n ]\n}", "MCP_role_object_fetcher": "{\n \"name\": \"Object Fetcher\",\n \"summary\": \"The Object Fetcher is in charge of fetching metadata information from Pricefx object\",\n \"prompt\": \"\",\n \"available_tools\": [\n \"fetch_objects\",\n \"parameters_list\"\n ]\n}\n" } ], "status": 0 } } } } } } } }, "operationId": "post-genai.mcp-roles", "description": "Retrieves available MCP Roles from the Advanced Configuration Options." } }, "/genai.mcp/tools": { "post": { "summary": "Get MCP Tools", "tags": [ "MCP" ], "responses": { "200": { "description": "Roles received.", "content": { "application/json": { "schema": { "type": "object", "properties": { "response": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "MCP_tool_parameters_read": { "type": "string" }, "MCP_tool_Agents_List": { "type": "string" }, "MCP_tool_schema_analytics_getdatamartdetails": { "type": "string" }, "MCP_tool_schema_master_listproductcustomerattributes": { "type": "string" }, "MCP_tool_agents_listimportantactions": { "type": "string" }, "MCP_tool_parameters_list": { "type": "string" }, "MCP_tool_Agents_GetActionItem": { "type": "string" }, "MCP_tool_schema_analytics_listdatamarts": { "type": "string" }, "MCP_tool_parameters_update": { "type": "string" } } } }, "status": { "type": "integer" } } } } }, "examples": { "Example 1": { "value": { "response": { "data": [ { "MCP_tool_parameters_read": "{\n \"name\": \"parameters_read\",\n \"title\": \"Parameters: Read\",\n \"description\": \"Retrieves rows from a parameter table, optionally filtered by field criteria\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Parameters\",\n \"functionName\": \"read\",\n \"inputSchema\": {\n \"properties\": {\n \"uniqueName\": {\n \"type\": \"string\",\n \"description\": \"Parameter table unique name\"\n },\n \"innerFilterCriteria\": {\n \"type\": \"array\",\n \"description\": \"List of field-value pairs for filtering rows. Default is empty (no filter).\",\n \"optional\": true,\n \"items\": {\n \"type\": \"object\",\n \"additionalProperties\": {\n \"type\": \"string\"\n }\n }\n },\n \"innerFilterOperator\": {\n \"type\": \"string\",\n \"description\": \"Criteria level filter for above criteria. Supports [contains, equals, notEqual]. Default: `contains`\",\n \"optional\": true\n },\n \"outerFilterOperator\": {\n \"type\": \"string\",\n \"description\": \"Group level operator for all given criteria. Supports [and, or]. Default: `and`\",\n \"optional\": true\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"table\": {\n \"type\": \"object\",\n \"description\": \"Parameter table metadata object\"\n },\n \"rows\": {\n \"type\": \"array\",\n \"description\": \"Filtered parameter table rows\",\n \"items\": {\n \"type\": \"array\"\n }\n }\n }\n }\n}\n", "MCP_tool_Agents_List": "{\n \"name\": \"agents_list\",\n \"title\": \"Agents: List\",\n \"description\": \"Retrieves agent objects with full metadata. Supports optional filtering by status, creator name, or last update within N days, as well as sorting by agents output fields and limiting the maximum number of returned results.\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Agents\",\n \"functionName\": \"list\",\n \"inputSchema\": {\n \"properties\": {\n \"filterStatus\": {\n \"type\": \"string\",\n \"description\": \"Filter on status field, list active agents means status equals READY\",\n \"optional\": true\n },\n \"filterCreatedByName\": {\n \"type\": \"string\",\n \"description\": \"List agents created by user, use createdByName field with Pricefx login name for filtering\",\n \"optional\": true\n },\n \"filterUpdatedLastNDays\": {\n \"type\": \"integer\",\n \"description\": \"List agents updated last N days\",\n \"optional\": true\n },\n \"sortBy\": {\n \"type\": \"string\",\n \"description\": \"Sort by an agent's output field except link, lastRunAt (for the last run sorting use -createDate) and actionsCount, can be prefixed with '-' for descending sort order, for updated by user sorting use lastUpdateByName field with Pricefx login name, default: -lastUpdateDate\",\n \"optional\": true\n },\n \"maxResults\": {\n \"type\": \"integer\",\n \"description\": \"Maximum number of records to return, default: 50\",\n \"optional\": true\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"table\": {\n \"type\": \"object\",\n \"description\": \"Agents table metadata\",\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"rows\": {\n \"type\": \"array\",\n \"description\": \"Agents raw data\",\n \"items\": {\n \"type\": \"array\"\n }\n }\n }\n }\n}", "MCP_tool_schema_analytics_getdatamartdetails": "{\n \"name\": \"schema_analytics_get_datamart_details\",\n \"title\": \"Schema Analytics: Get Datamart Details\",\n \"description\": \"Retrieves datamart schema, row count, and field definitions\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Schema_Analytics\",\n \"functionName\": \"getDatamartDetails\",\n \"inputSchema\": {\n \"properties\": {\n \"uniqueName\": {\n \"type\": \"string\",\n \"description\": \"Datamart unique name\"\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Datamart ID\",\n \"optional\": true\n },\n \"uniqueName\": {\n \"type\": \"string\",\n \"description\": \"Datamart unique name\",\n \"optional\": true\n },\n \"label\": {\n \"type\": \"string\",\n \"description\": \"Display label\",\n \"optional\": true\n },\n \"baseUomCode\": {\n \"type\": \"string\",\n \"description\": \"Base unit of measure\",\n \"optional\": true\n },\n \"baseCcyCode\": {\n \"type\": \"string\",\n \"description\": \"Base currency code\",\n \"optional\": true\n },\n \"rowCount\": {\n \"type\": \"integer\",\n \"description\": \"Total row count\",\n \"optional\": true\n },\n \"fields\": {\n \"type\": \"array\",\n \"description\": \"Field definitions (name, label, type, dimension, expression)\",\n \"optional\": true,\n \"items\": {\n \"type\": \"object\"\n }\n },\n \"error\": {\n \"type\": \"string\",\n \"description\": \"Error message if datamart not found\",\n \"optional\": true\n }\n }\n }\n}\n", "MCP_tool_schema_master_listproductcustomerattributes": "{\n \"name\": \"schema_master_list_product_customer_attributes\",\n \"title\": \"Schema Master: List Product Customer Attributes\",\n \"description\": \"Lists product (PAM) and customer (CAM) attribute field definitions\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Schema_Master\",\n \"functionName\": \"getAttributeMetadata\",\n \"inputSchema\": {},\n \"outputSchema\": {\n \"properties\": {\n \"keyInformation\": {\n \"type\": \"string\",\n \"description\": \"Summary description\"\n },\n \"objectsByTypeCode\": {\n \"type\": \"object\",\n \"description\": \"Attributes grouped by type (PAM/CAM) with fieldName, label, and fieldType\"\n }\n }\n }\n}\n", "MCP_tool_agents_listimportantactions": "{\n \"name\": \"pricefx_acc_get_agents_important_actions\",\n \"title\": \"Get agent's important actions list\",\n \"description\": \"Provides a list of top important actions based on a requested or predefined metrics\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"ActionItems\",\n \"functionName\": \"listImportant\",\n \"inputSchema\": {\n \"properties\": {\n \"assignedTo\": {\n \"type\": \"string\",\n \"description\": \"A string with user login\",\n \"optional\": true\n },\n \"actionTypes\": {\n \"type\": \"array\",\n \"description\": \"A list of action types like [\\\"AG_Action_Pricing\\\", \\\"ActIn_Action\\\"]\",\n \"optional\": true,\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"A string with action status\",\n \"optional\": true\n },\n \"orderBy\": {\n \"type\": \"string\",\n \"description\": \"A string with impact score used to sort returned Actions\",\n \"optional\": true\n },\n \"resultLimit\": {\n \"type\": \"integer\",\n \"description\": \"Maximum number of returned Actions.\",\n \"optional\": true\n },\n \"timeWindow\": {\n \"type\": \"integer\",\n \"description\": \"The time period in days from today's date. The results will show actions created in the last 'timeWindow' days.\",\n \"optional\": true\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"importantAgentActions\": {\n \"type\": \"array\",\n \"description\": \"An array of Action Items with high level details.\",\n \"items\": {\n \"type\": \"object\"\n }\n }\n }\n }\n}\n", "MCP_tool_parameters_list": "{\n \"name\": \"parameters_list\",\n \"title\": \"Parameters: List\",\n \"description\": \"Lists parameter tables filtered by uniqueName or label pattern. Be careful not to enumerate too many tables, use the search & results inputs wisely.\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Parameters\",\n \"functionName\": \"list\",\n \"inputSchema\": {\n \"properties\": {\n \"searchTerm\": {\n \"description\": \"Case-insensitive search on table uniqueName or label\",\n \"type\": \"string\",\n \"optional\": true\n },\n \"nResults\": {\n \"description\": \"Number of parameter tables to return. Default: 5.\",\n \"type\": \"int\",\n \"optional\": true\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"tables\": {\n \"type\": \"array\",\n \"description\": \"Parameter table metadata objects\",\n \"items\": {\n \"type\": \"object\"\n }\n }\n }\n }\n}\n", "MCP_tool_Agents_GetActionItem": "{\n \"name\": \"pricefx_acc_agents_get_action_item\",\n \"title\": \"Get Action Item\",\n \"description\": \"Retrieves detailed action item information including agent impact fields\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"ActionItems\",\n \"functionName\": \"getActionItem\",\n \"inputSchema\": {\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Unique name of an action item\",\n \"optional\": true\n },\n \"typedId\": {\n \"type\": \"string\",\n \"description\": \"Typed id of an action item\",\n \"optional\": true\n },\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Id of an action item\",\n \"optional\": true\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"Id of the action item\"\n },\n \"uniqueName\": {\n \"type\": \"string\",\n \"description\": \"Unique name of the action item\"\n },\n \"summary\": {\n \"type\": \"string\",\n \"description\": \"A short description set up by the action item creator\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"A long description set up by the action item creator\"\n },\n \"status\": {\n \"type\": \"string\",\n \"description\": \"Current status of the action item. Can be one of Open, Done, Blocked, Postponed, Rejected\"\n },\n \"assignedToLoginName\": {\n \"type\": \"string\",\n \"description\": \"Login name of the user that this action item was assigned to\"\n },\n \"dueDate\": {\n \"type\": \"string\",\n \"description\": \"A date when this action is supposed to be finished\"\n },\n \"createDate\": {\n \"type\": \"string\",\n \"description\": \"A date when this action was created\"\n },\n \"createdByLoginName\": {\n \"type\": \"string\",\n \"description\": \"Login name of the user that created this action\"\n },\n \"lastUpdateDate\": {\n \"type\": \"string\",\n \"description\": \"A date when this action was last updated\"\n },\n \"parentTypedId\": {\n \"type\": \"string\",\n \"description\": \"Typed id of a parent object\"\n },\n \"originatorTypedId\": {\n \"type\": \"string\",\n \"description\": \"Typed id of an object that this action item originates from\"\n },\n \"pfxAcc_AG_profitImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Profit Impact Measure\"\n },\n \"pfxAcc_AG_profitImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Profit Impact value\"\n },\n \"pfxAcc_AG_revenueImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Revenue Impact Measure\"\n },\n \"pfxAcc_AG_revenueImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Revenue Impact value\"\n },\n \"pfxAcc_AG_costsImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Costs Impact Measure\"\n },\n \"pfxAcc_AG_costsImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Costs Impact value\"\n },\n \"pfxAcc_AG_trendsImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Trends Impact Measure\"\n },\n \"pfxAcc_AG_trendsImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Trends Impact value\"\n },\n \"pfxAcc_AG_benchmarkImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Benchmark Impact Measure\"\n },\n \"pfxAcc_AG_benchmarkImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Benchmark Impact value\"\n },\n \"pfxAcc_AG_targetImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Target Impact Measure\"\n },\n \"pfxAcc_AG_targetImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Target Impact value\"\n },\n \"pfxAcc_AG_othersImpactMeasureName\": {\n \"type\": \"string\",\n \"description\": \"A field name for the Others Impact Measure\"\n },\n \"pfxAcc_AG_othersImpact\": {\n \"type\": \"decimal\",\n \"description\": \"Others Impact value\"\n },\n \"assignedToEmail\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the user that this action item is assigned to\"\n },\n \"assignedToFirstName\": {\n \"type\": \"string\",\n \"description\": \"First name of the user that this action item is assigned to\"\n },\n \"assignedToLastName\": {\n \"type\": \"string\",\n \"description\": \"Last name of the user that this action item is assigned to\"\n },\n \"createdByEmail\": {\n \"type\": \"string\",\n \"description\": \"E-mail address of the user that created this action item\"\n },\n \"createdByFirstName\": {\n \"type\": \"string\",\n \"description\": \"First name of the user that created this action item\"\n },\n \"createdByLastName\": {\n \"type\": \"string\",\n \"description\": \"Last name of the user that created this action item\"\n },\n \"detailsLink\": {\n \"type\": \"string\",\n \"description\": \"A hyperlink to this action item details page\"\n },\n \"originatorLink\": {\n \"type\": \"string\",\n \"description\": \"A hyperlink to the object this action item originates from\"\n }\n }\n }\n}\n", "MCP_tool_schema_analytics_listdatamarts": "{\n \"name\": \"schema_analytics_list_datamarts\",\n \"title\": \"Schema Analytics: List Datamarts\",\n \"description\": \"Lists all datamarts with basic info (use get_datamart_details for full schema)\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Schema_Analytics\",\n \"functionName\": \"getDataSchema\",\n \"inputSchema\": {},\n \"outputSchema\": {\n \"properties\": {\n \"keyInformation\": {\n \"type\": \"string\",\n \"description\": \"Summary description\"\n },\n \"datamarts\": {\n \"type\": \"object\",\n \"description\": \"Datamarts keyed by uniqueName with id and label\"\n }\n }\n }\n}\n", "MCP_tool_parameters_update": "{\n \"name\": \"parameters_update\",\n \"title\": \"Parameters: Update\",\n \"description\": \"Upserts rows into a parameter table using name as business key\",\n \"formulaName\": \"MCP_Commons\",\n \"elementName\": \"Parameters\",\n \"functionName\": \"update\",\n \"allowObjectMods\": true,\n \"inputSchema\": {\n \"properties\": {\n \"uniqueName\": {\n \"type\": \"string\",\n \"description\": \"Parameter table unique name\"\n },\n \"rows\": {\n \"type\": \"array\",\n \"description\": \"Rows to upsert (matched by key columns defined in table)\",\n \"items\": {\n \"type\": \"object\"\n }\n }\n }\n },\n \"outputSchema\": {\n \"properties\": {\n \"updatedCount\": {\n \"type\": \"integer\",\n \"description\": \"Raw result from api.addOrUpdate() operation (count of modified records)\"\n },\n \"updatedRows\": {\n \"type\": \"array\",\n \"description\": \"Updated rows re-read from the parameter table after update\",\n \"items\": {\n \"type\": \"array\"\n }\n }\n }\n }\n}\n" } ], "status": 0 } } } } } } } }, "operationId": "post-genai.mcp-tools", "description": "Retrieves available MCP Tools from the Advanced Configuration Options." } }, "/clicmanager.additems/{typedId}": { "parameters": [ { "schema": { "type": "string" }, "name": "typedId", "in": "path", "required": true, "description": "typed ID of the target CLIC document " } ], "post": { "summary": "Add Line Items", "operationId": "post-clicmanager.additems-typedId", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "examples": {} }, "application/xml": { "schema": { "type": "object", "properties": {} } }, "multipart/form-data": { "schema": { "type": "object", "properties": { "status": { "type": "integer" }, "errors": { "type": "object", "properties": {} }, "data": { "type": "object", "properties": { "typedId": { "type": "string" }, "objectType": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "version": { "type": "integer" }, "creationWorkflowStatus": { "type": "string" }, "creationWorkflowCurrentStep": { "type": "integer" }, "creationWorkflowStepCount": { "type": "integer" }, "creationWorkflowStepLabel": { "type": "string" }, "creationWorkflowCurrentStepIsReview": { "type": "boolean" }, "newLineIds": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "typedId": { "type": "string" }, "parentId": { "type": "string" }, "contractTermType": { "type": "string" }, "label": { "type": "string" }, "folder": { "type": "boolean" }, "dirty": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer" } } } }, "outputs": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } } } } } } } }, "tags": [ "Clicmanager" ], "description": "Adds new line items, with optional inputs and label, to a CLIC document (Quote, Agreement/Promotion, Rebate Agreement or Compensation Plan) identified by its typedId.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "contractTermTypes": { "type": "array", "items": { "type": "object", "properties": { "contractTermType": { "type": "string" }, "dirty": { "type": "boolean" }, "label": { "type": "string" }, "folder": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "nullable": true } } } }, "outputs": { "type": "array", "items": { "type": "object" } } } } } } } } }, "examples": { "Example 1": { "value": { "data": { "contractTermTypes": [ { "contractTermType": "SimplePromotion", "dirty": true, "label": "Simple Promotion", "folder": true, "inputs": [ { "name": "Promotion €", "value": "string" } ], "outputs": [ {} ] } ] } } } } } } } } } }, "components": { "schemas": { "ActivityTrail": { "title": "ActivityTrail", "description": "The type code is ACTT", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "clientIP": { "type": "string", "maxLength": 255 }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "command": { "type": "string", "maxLength": 60 }, "timestamp": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ActionItem": { "title": "ActionItem", "description": "The type code is AI.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255, "nullable": true }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "createdByName": { "type": "string", "maxLength": 255, "nullable": true }, "typedId": { "type": "string" }, "assignedToName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "actionItemType": { "type": "string" }, "description": { "type": "string", "nullable": true }, "parentTabName": { "type": "string", "maxLength": 255, "nullable": true }, "assignedTo": { "type": "integer" }, "assignedToGroup": { "type": "string", "maxLength": 255, "nullable": true }, "sourceContext": { "type": "string", "maxLength": 255, "nullable": true }, "targetContext": { "type": "string", "maxLength": 255, "nullable": true }, "parentTypedId": { "type": "string", "maxLength": 255, "nullable": true }, "completedByName": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "summary": { "type": "string", "maxLength": 255 }, "originatorTypedId": { "type": "string", "maxLength": 255, "nullable": true }, "version": { "type": "integer" }, "completedDate": { "type": "string", "format": "date-time", "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "completedBy": { "type": "integer", "nullable": true }, "status": { "type": "string", "maxLength": 255, "enum": [ "OPEN", "DONE", "REJECTED", "BLOCKED", "POSTPONED" ] }, "lastUpdateBy": { "type": "integer" } }, "required": [ "actionItemType", "assignedTo", "summary" ] }, "ActionItemType": { "title": "ActionItemType", "description": "The type code is AIT.\n>Action Types can be added or edited via UI: Administration > Configuration > Actions > Action Types", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255, "description": "A name of the Action Item Logic used by this type. See the [Action Item Logic](https://pricefx.atlassian.net/wiki/spaces/KB/pages/4601675834/Action+Item+Logic) documentation.", "nullable": true }, "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255, "description": "A unique name of the Action Item Type." }, "configuration": { "type": "object", "description": "Tabs defined as a JSON. Used for configuring dynamicTabs in actions, labels of the tabs etc. See the [Detail Page Layout and Dynamic Tabs](https://pricefx.atlassian.net/wiki/spaces/KB/pages/3980492805/Detail+Page+Layout+and+Dynamic+Tabs) documentation." }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } }, "required": [ "uniqueName" ] }, "ApplicationProperties": { "title": "ApplicationProperties", "description": "The type code is AP", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "value": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "APIKey": { "title": "APIKey", "description": "The type code is APIK", "type": "object", "properties": { "registrationEnabled": { "type": "boolean" }, "typedId": { "type": "string" }, "apiKey": { "type": "string", "maxLength": 255 }, "renewRefreshToken": { "type": "boolean" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "maxAttempts": { "type": "integer" }, "createdBy": { "type": "integer" }, "rsaPublic": { "type": "string" }, "partitionNames": { "type": "string" }, "expiry": { "type": "integer" }, "activated": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "BinaryData": { "title": "BinaryData", "description": "The type code is BD.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255, "nullable": true }, "createdByName": { "type": "string", "maxLength": 255 }, "fileName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time", "nullable": true }, "length": { "type": "integer" }, "latestUploadStatusId": { "type": "integer" }, "version": { "type": "integer" }, "sender": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "recipients": { "type": "string", "maxLength": 255, "nullable": true }, "sentViaEmail": { "type": "boolean" }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "contentType": { "type": "string", "maxLength": 255 }, "embeddedOwner": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "BoundPartition": { "title": "BoundPartition", "description": "The type code is BPT", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "integrationHost": { "type": "string", "maxLength": 255 }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "integrationPort": { "type": "integer" }, "baseUrl": { "type": "string", "maxLength": 255 }, "password": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "partitionName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "BusinessRole": { "title": "BusinessRole", "description": "The type code is BR", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "module": { "type": "string", "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS" ] }, "label": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo3": { "type": "string" }, "additionalInfo4": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Customer": { "title": "Customer", "description": "The Customer object. The Type code is C.

\n**MassEditable**: yes
\n**bulkLoadable**: yes", "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "customerId": { "maxLength": 255, "type": "string" }, "isParent": { "type": "boolean", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "typedId": { "type": "string" }, "userGroupEdit": { "maxLength": 255, "type": "string" }, "userGroupViewDetails": { "maxLength": 255, "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 255, "type": "string" }, "attribute2": { "maxLength": 255, "type": "string" }, "attribute3": { "maxLength": 255, "type": "string" }, "attribute4": { "maxLength": 255, "type": "string" }, "attribute5": { "maxLength": 255, "type": "string" }, "attribute6": { "maxLength": 255, "type": "string" }, "attribute7": { "maxLength": 255, "type": "string" }, "attribute8": { "maxLength": 255, "type": "string" }, "attribute9": { "maxLength": 255, "type": "string" }, "attribute10": { "maxLength": 255, "type": "string" }, "attribute11": { "maxLength": 255, "type": "string" }, "attribute12": { "maxLength": 255, "type": "string" }, "attribute13": { "maxLength": 255, "type": "string" }, "attribute14": { "maxLength": 255, "type": "string" }, "attribute15": { "maxLength": 255, "type": "string" }, "attribute16": { "maxLength": 255, "type": "string" }, "attribute17": { "maxLength": 255, "type": "string" }, "attribute18": { "maxLength": 255, "type": "string" }, "attribute19": { "maxLength": 255, "type": "string" }, "attribute20": { "maxLength": 255, "type": "string" }, "attribute21": { "maxLength": 255, "type": "string" }, "attribute22": { "maxLength": 255, "type": "string" }, "attribute23": { "maxLength": 255, "type": "string" }, "attribute24": { "maxLength": 255, "type": "string" }, "attribute25": { "maxLength": 255, "type": "string" }, "attribute26": { "maxLength": 255, "type": "string" }, "attribute27": { "maxLength": 255, "type": "string" }, "attribute28": { "maxLength": 255, "type": "string" }, "attribute29": { "maxLength": 255, "type": "string" }, "attribute30": { "maxLength": 255, "type": "string" } } }, "CustomerAssignment": { "title": "CustomerAssignment", "description": "The type code is CA", "type": "object", "properties": { "additionalInfo4": { "type": "string", "maxLength": 255 }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "additionalInfo2": { "type": "number" }, "typedId": { "type": "string" }, "additionalInfo1": { "type": "number" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "assignment": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "priority": { "type": "integer" }, "version": { "type": "integer" }, "assignmentId": { "type": "integer" }, "createdBy": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CustomerAttributeMeta": { "title": "CustomerAttributeMeta", "description": "The type code is CAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CustomerDescription": { "title": "CustomerDescription", "description": "The type code is CDESC", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "customerId": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CalculationGrid": { "title": "CalculationGrid", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255, "nullable": true }, "createdByName": { "type": "string", "maxLength": 255, "nullable": true }, "updateDate": { "type": "string", "format": "date", "nullable": true }, "typedId": { "type": "string" }, "configuration": { "type": "string" }, "relativeTargetDateDays": { "type": "integer", "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "numberOfSubmittedItems": { "type": "integer" }, "numberOfAutoApprovedItems": { "type": "integer" }, "locale": { "type": "string", "maxLength": 255, "nullable": true }, "numberOfDeniedItems": { "type": "integer" }, "calculationDate": { "type": "string", "format": "date-time", "nullable": true }, "keyGenerationType": { "type": "string", "maxLength": 255, "enum": [ "DATA_DRIVEN", "LOGIC_DRIVEN", "MANUAL" ] }, "writeOnlyChangedItems": { "type": "boolean" }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "id": { "type": "integer" }, "calculationGridType": { "type": "string", "maxLength": 255, "enum": [ "CG1", "CG2", "CG3", "CG4", "CG5", "CG6", null ], "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "calculationMessages": { "type": "string", "nullable": true }, "updatedBy": { "type": "integer" }, "numberOfApprovedItems": { "type": "integer" }, "keySize": { "type": "integer" }, "targetDate": { "type": "string", "format": "date" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "partialCalculationDate": { "type": "string", "format": "date-time", "nullable": true }, "numberOfOpenItems": { "type": "integer" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "nodeId": { "type": "integer", "nullable": true }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "approvalLevel": { "type": "string", "maxLength": 255, "enum": [ "LINE_ITEM" ] } }, "description": "The type code is CG." }, "CalculationGridItem1Key": { "title": "CalculationGridItem1Key", "type": "object", "description": "The type code is CGI1.", "properties": { "alerts": { "type": "string" }, "allCalculationResults": { "type": "array", "items": { "additionalProperties": { "type": "object" }, "type": "object" } }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" }, "calculatedResultSignificantValue": { "type": "number" }, "calculationGridId": { "type": "integer" }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } } } }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "string" }, "key1": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer" }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string" }, "manualResultSignificantValue": { "type": "number" }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number" }, "resultSignificantValue": { "type": "number" }, "significantValueChange": { "type": "number" }, "significantValueChangePct": { "type": "number" }, "tableId": { "type": "integer" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" } } }, "CalculationGridItem2Key": { "title": "CalculationGridItem2Key", "type": "object", "description": "The type code is CGI2.", "properties": { "alerts": { "type": "string" }, "allCalculationResults": { "type": "array", "items": { "additionalProperties": { "type": "object" }, "type": "object" } }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" }, "calculatedResultSignificantValue": { "type": "number" }, "calculationGridId": { "type": "integer" }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } } } }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "string" }, "key1": { "maxLength": 255, "type": "string" }, "key2": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer" }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string" }, "manualResultSignificantValue": { "type": "number" }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number" }, "resultSignificantValue": { "type": "number" }, "significantValueChange": { "type": "number" }, "significantValueChangePct": { "type": "number" }, "tableId": { "type": "integer" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" } } }, "CalculationGridItem3Key": { "title": "CalculationGridItem3Key", "type": "object", "description": "The type code is CGI3.", "properties": { "alerts": { "type": "string" }, "allCalculationResults": { "type": "array", "items": { "additionalProperties": { "type": "object" }, "type": "object" } }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" }, "calculatedResultSignificantValue": { "type": "number" }, "calculationGridId": { "type": "integer" }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } } } }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "string" }, "key1": { "maxLength": 255, "type": "string" }, "key2": { "maxLength": 255, "type": "string" }, "key3": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer" }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string" }, "manualResultSignificantValue": { "type": "number" }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number" }, "resultSignificantValue": { "type": "number" }, "significantValueChange": { "type": "number" }, "significantValueChangePct": { "type": "number" }, "tableId": { "type": "integer" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" } } }, "CalculationGridItem4Key": { "title": "CalculationGridItem4Key", "type": "object", "properties": { "alerts": { "type": "string" }, "allCalculationResults": { "items": { "additionalProperties": { "type": "object" }, "type": "object" }, "type": "array" }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" }, "calculatedResultSignificantValue": { "type": "number" }, "calculationGridId": { "type": "integer" }, "calculationResults": { "items": { "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "string" }, "key1": { "maxLength": 255, "type": "string" }, "key2": { "maxLength": 255, "type": "string" }, "key3": { "maxLength": 255, "type": "string" }, "key4": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer" }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string" }, "manualResultSignificantValue": { "type": "number" }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number" }, "resultSignificantValue": { "type": "number" }, "significantValueChange": { "type": "number" }, "significantValueChangePct": { "type": "number" }, "tableId": { "type": "integer" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" } }, "description": "The type code is CGI4." }, "CalculationGridItem5Key": { "title": "CalculationGridItem5Key", "type": "object", "properties": { "alerts": { "type": "string" }, "allCalculationResults": { "items": { "additionalProperties": { "type": "object" }, "type": "object" }, "type": "array" }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" }, "calculatedResultSignificantValue": { "type": "number" }, "calculationGridId": { "type": "integer" }, "calculationResults": { "items": { "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "string" }, "key1": { "maxLength": 255, "type": "string" }, "key2": { "maxLength": 255, "type": "string" }, "key3": { "maxLength": 255, "type": "string" }, "key4": { "maxLength": 255, "type": "string" }, "key5": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer" }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string" }, "manualResultSignificantValue": { "type": "number" }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number" }, "resultSignificantValue": { "type": "number" }, "significantValueChange": { "type": "number" }, "significantValueChangePct": { "type": "number" }, "tableId": { "type": "integer" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" } }, "description": "The type code is CGI5." }, "CalculationGridItem6Key": { "title": "CalculationGridItem6Key", "type": "object", "description": "The type code is CGI6.", "properties": { "alerts": { "type": "string", "nullable": true }, "allCalculationResults": { "type": "array", "items": { "additionalProperties": { "type": "object" }, "type": "object" } }, "allowedOverrides": { "maxLength": 1300, "type": "string", "nullable": true }, "attribute1": { "maxLength": 70, "type": "string", "nullable": true }, "attribute2": { "maxLength": 70, "type": "string", "nullable": true }, "attribute3": { "maxLength": 70, "type": "string", "nullable": true }, "attribute4": { "maxLength": 70, "type": "string", "nullable": true }, "attribute5": { "maxLength": 70, "type": "string", "nullable": true }, "attribute6": { "maxLength": 70, "type": "string", "nullable": true }, "attribute7": { "maxLength": 70, "type": "string", "nullable": true }, "attribute8": { "maxLength": 70, "type": "string", "nullable": true }, "attribute9": { "maxLength": 70, "type": "string", "nullable": true }, "attribute10": { "maxLength": 70, "type": "string", "nullable": true }, "attribute11": { "maxLength": 70, "type": "string", "nullable": true }, "attribute12": { "maxLength": 70, "type": "string", "nullable": true }, "attribute13": { "maxLength": 70, "type": "string", "nullable": true }, "attribute14": { "maxLength": 70, "type": "string", "nullable": true }, "attribute15": { "maxLength": 70, "type": "string", "nullable": true }, "attribute16": { "maxLength": 70, "type": "string", "nullable": true }, "attribute17": { "maxLength": 70, "type": "string", "nullable": true }, "attribute18": { "maxLength": 70, "type": "string", "nullable": true }, "attribute19": { "maxLength": 70, "type": "string", "nullable": true }, "attribute20": { "maxLength": 70, "type": "string", "nullable": true }, "attribute21": { "maxLength": 70, "type": "string", "nullable": true }, "attribute22": { "maxLength": 70, "type": "string", "nullable": true }, "attribute23": { "maxLength": 70, "type": "string", "nullable": true }, "attribute24": { "maxLength": 70, "type": "string", "nullable": true }, "attribute25": { "maxLength": 70, "type": "string", "nullable": true }, "attribute26": { "maxLength": 70, "type": "string", "nullable": true }, "attribute27": { "maxLength": 70, "type": "string", "nullable": true }, "attribute28": { "maxLength": 70, "type": "string", "nullable": true }, "attribute29": { "maxLength": 70, "type": "string", "nullable": true }, "attribute30": { "maxLength": 70, "type": "string", "nullable": true }, "attribute31": { "maxLength": 70, "type": "string", "nullable": true }, "attribute32": { "maxLength": 70, "type": "string", "nullable": true }, "attribute33": { "maxLength": 70, "type": "string", "nullable": true }, "attribute34": { "maxLength": 70, "type": "string", "nullable": true }, "attribute35": { "maxLength": 70, "type": "string", "nullable": true }, "attribute36": { "maxLength": 70, "type": "string", "nullable": true }, "attribute37": { "maxLength": 70, "type": "string", "nullable": true }, "attribute38": { "maxLength": 70, "type": "string", "nullable": true }, "attribute39": { "maxLength": 70, "type": "string", "nullable": true }, "attribute40": { "maxLength": 70, "type": "string", "nullable": true }, "attribute41": { "maxLength": 70, "type": "string", "nullable": true }, "attribute42": { "maxLength": 70, "type": "string", "nullable": true }, "attribute43": { "maxLength": 70, "type": "string", "nullable": true }, "attribute44": { "maxLength": 70, "type": "string", "nullable": true }, "attribute45": { "maxLength": 70, "type": "string", "nullable": true }, "attribute46": { "maxLength": 70, "type": "string", "nullable": true }, "attribute47": { "maxLength": 70, "type": "string", "nullable": true }, "attribute48": { "maxLength": 70, "type": "string", "nullable": true }, "attribute49": { "maxLength": 70, "type": "string", "nullable": true }, "attribute50": { "maxLength": 70, "type": "string", "nullable": true }, "attribute51": { "maxLength": 70, "type": "string", "nullable": true }, "attribute52": { "maxLength": 70, "type": "string", "nullable": true }, "attribute53": { "maxLength": 70, "type": "string", "nullable": true }, "attribute54": { "maxLength": 70, "type": "string", "nullable": true }, "attribute55": { "maxLength": 70, "type": "string", "nullable": true }, "attribute56": { "maxLength": 70, "type": "string", "nullable": true }, "attribute57": { "maxLength": 70, "type": "string", "nullable": true }, "attribute58": { "maxLength": 70, "type": "string", "nullable": true }, "attribute59": { "maxLength": 70, "type": "string", "nullable": true }, "attribute60": { "maxLength": 70, "type": "string", "nullable": true }, "attribute61": { "maxLength": 70, "type": "string", "nullable": true }, "attribute62": { "maxLength": 70, "type": "string", "nullable": true }, "attribute63": { "maxLength": 70, "type": "string", "nullable": true }, "attribute64": { "maxLength": 70, "type": "string", "nullable": true }, "attribute65": { "maxLength": 70, "type": "string", "nullable": true }, "attribute66": { "maxLength": 70, "type": "string", "nullable": true }, "attribute67": { "maxLength": 70, "type": "string", "nullable": true }, "attribute68": { "maxLength": 70, "type": "string", "nullable": true }, "attribute69": { "maxLength": 70, "type": "string", "nullable": true }, "attribute70": { "maxLength": 70, "type": "string", "nullable": true }, "attribute71": { "maxLength": 70, "type": "string", "nullable": true }, "attribute72": { "maxLength": 70, "type": "string", "nullable": true }, "attribute73": { "maxLength": 70, "type": "string", "nullable": true }, "attribute74": { "maxLength": 70, "type": "string", "nullable": true }, "attribute75": { "maxLength": 70, "type": "string", "nullable": true }, "attribute76": { "maxLength": 70, "type": "string", "nullable": true }, "attribute77": { "maxLength": 70, "type": "string", "nullable": true }, "attribute78": { "maxLength": 70, "type": "string", "nullable": true }, "attribute79": { "maxLength": 70, "type": "string", "nullable": true }, "attribute80": { "maxLength": 70, "type": "string", "nullable": true }, "attribute81": { "maxLength": 70, "type": "string", "nullable": true }, "attribute82": { "maxLength": 70, "type": "string", "nullable": true }, "attribute83": { "maxLength": 70, "type": "string", "nullable": true }, "attribute84": { "maxLength": 70, "type": "string", "nullable": true }, "attribute85": { "maxLength": 70, "type": "string", "nullable": true }, "attribute86": { "maxLength": 70, "type": "string", "nullable": true }, "attribute87": { "maxLength": 70, "type": "string", "nullable": true }, "attribute88": { "maxLength": 70, "type": "string", "nullable": true }, "attribute89": { "maxLength": 70, "type": "string", "nullable": true }, "attribute90": { "maxLength": 70, "type": "string", "nullable": true }, "attribute91": { "maxLength": 70, "type": "string", "nullable": true }, "attribute92": { "maxLength": 70, "type": "string", "nullable": true }, "attribute93": { "maxLength": 70, "type": "string", "nullable": true }, "attribute94": { "maxLength": 70, "type": "string", "nullable": true }, "attribute95": { "maxLength": 70, "type": "string", "nullable": true }, "attribute96": { "maxLength": 70, "type": "string", "nullable": true }, "attribute97": { "maxLength": 70, "type": "string", "nullable": true }, "attribute98": { "maxLength": 70, "type": "string", "nullable": true }, "attribute99": { "maxLength": 70, "type": "string", "nullable": true }, "attribute100": { "maxLength": 70, "type": "string", "nullable": true }, "calculatedResultSignificantValue": { "type": "number", "nullable": true }, "calculationGridId": { "type": "integer" }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": {} }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "type": "array", "items": { "type": "string" } } } } }, "comments": { "maxLength": 255, "type": "string", "nullable": true }, "completeResultsAvailable": { "type": "boolean" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "itemExtensions": { "type": "object", "nullable": true }, "key1": { "type": "string" }, "key2": { "type": "string" }, "key3": { "type": "string" }, "key4": { "type": "string" }, "key5": { "type": "string" }, "key6": { "type": "string" }, "label": { "maxLength": 255, "type": "string", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "manualEditUser": { "type": "integer", "nullable": true }, "manualEditVersion": { "type": "integer" }, "manualOverrides": { "type": "string", "nullable": true }, "manualResultSignificantValue": { "type": "number", "nullable": true }, "name": { "type": "string" }, "previousSignificantValue": { "type": "number", "nullable": true }, "resultSignificantValue": { "type": "number", "nullable": true }, "significantValueChange": { "type": "number", "nullable": true }, "significantValueChangePct": { "type": "number", "nullable": true }, "tableId": { "type": "integer", "nullable": true }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "warnings": { "type": "string", "nullable": true }, "workStatus": { "maxLength": 15, "type": "string", "nullable": true } } }, "CalculationFlow": { "title": "CalculationFlow", "description": "The type code is CF", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "configuration": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "flowId": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CalculatedFieldSet": { "title": "CalculatedFieldSet", "description": "The type code is CFS", "type": "object", "properties": { "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "relativeTargetDateDays": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "writeOnlyChangedItems": { "type": "boolean" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "numberOfFailedItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "CalculationFlowTrait": { "title": "CalculationFlowTrait", "description": "The type code is CFT", "type": "object", "properties": { "flowItemId": { "type": "string", "maxLength": 255 }, "processed": { "type": "boolean" }, "typedId": { "type": "string" }, "traitType": { "type": "string", "maxLength": 255, "enum": [ "START_IMMEDIATELY" ] }, "configuration": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "traitId": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "flowId": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CommentHistory": { "title": "CommentHistory", "description": "The type code is CH", "type": "object", "properties": { "typedId": { "type": "string" }, "comments": { "type": "string", "maxLength": 255 }, "parentLabel": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "itemTypedId": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "parentTypedId": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Claim": { "title": "Claim", "description": "The type code is CL.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "fileName": { "type": "string", "maxLength": 255, "nullable": true }, "typedId": { "type": "string" }, "claimRecord": { "type": "string", "maxLength": 255, "nullable": true }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "submitDate": { "type": "string", "format": "date-time", "nullable": true }, "locale": { "type": "string", "maxLength": 255, "nullable": true }, "calculationDate": { "type": "string", "format": "date-time", "nullable": true }, "externalRef": { "type": "string", "maxLength": 255, "nullable": true }, "deniedByName": { "type": "string", "maxLength": 255, "nullable": true }, "claimType": { "type": "string", "maxLength": 255 }, "fileHandle": { "type": "string", "maxLength": 255, "nullable": true }, "sourceQuoteUniqueName": { "type": "string", "maxLength": 255, "nullable": true }, "customerId": { "type": "string", "maxLength": 255, "nullable": true }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "maxLength": 255, "nullable": true }, "id": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "sourceContractUniqueName": { "type": "string", "maxLength": 255, "nullable": true }, "calculationMessages": { "type": "string", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "nullable": true, "items": { "type": "object" } }, "targetDate": { "type": "string", "format": "date", "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "customerName": { "type": "string", "maxLength": 255, "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "progress": { "type": "string", "maxLength": 255, "nullable": true }, "claimStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "REVOKED" ] }, "calculationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "ClaimLineItem": { "title": "ClaimLineItem", "description": "The type code is CLLI.", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute83": { "type": "string", "maxLength": 70, "nullable": true }, "attribute82": { "type": "string", "maxLength": 70, "nullable": true }, "attribute81": { "type": "string", "maxLength": 70, "nullable": true }, "attribute80": { "type": "string", "maxLength": 70, "nullable": true }, "attribute89": { "type": "string", "maxLength": 70, "nullable": true }, "attribute88": { "type": "string", "maxLength": 70, "nullable": true }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "maxLength": 70, "nullable": true }, "attribute86": { "type": "string", "maxLength": 70, "nullable": true }, "attribute85": { "type": "string", "maxLength": 70, "nullable": true }, "attribute84": { "type": "string", "maxLength": 70, "nullable": true }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 70, "nullable": true }, "attribute94": { "type": "string", "maxLength": 70, "nullable": true }, "attribute8": { "type": "string", "maxLength": 70, "nullable": true }, "attribute93": { "type": "string", "maxLength": 70, "nullable": true }, "attribute92": { "type": "string", "maxLength": 70, "nullable": true }, "attribute91": { "type": "string", "maxLength": 70, "nullable": true }, "attribute5": { "type": "string", "maxLength": 70, "nullable": true }, "attribute90": { "type": "string", "maxLength": 70, "nullable": true }, "attribute4": { "type": "string", "maxLength": 70, "nullable": true }, "attribute7": { "type": "string", "maxLength": 70, "nullable": true }, "attribute6": { "type": "string", "maxLength": 70, "nullable": true }, "attribute1": { "type": "string", "maxLength": 70, "nullable": true }, "attribute14": { "type": "string", "maxLength": 70, "nullable": true }, "attribute13": { "type": "string", "maxLength": 70, "nullable": true }, "attribute3": { "type": "string", "maxLength": 70, "nullable": true }, "attribute12": { "type": "string", "maxLength": 70, "nullable": true }, "endCustomerId": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 70, "nullable": true }, "attribute11": { "type": "string", "maxLength": 70, "nullable": true }, "attribute99": { "type": "string", "maxLength": 70, "nullable": true }, "attribute10": { "type": "string", "maxLength": 70, "nullable": true }, "attribute98": { "type": "string", "maxLength": 70, "nullable": true }, "attribute97": { "type": "string", "maxLength": 70, "nullable": true }, "attribute96": { "type": "string", "maxLength": 70, "nullable": true }, "attribute95": { "type": "string", "maxLength": 70, "nullable": true }, "attribute19": { "type": "string", "maxLength": 70, "nullable": true }, "attribute18": { "type": "string", "maxLength": 70, "nullable": true }, "attribute17": { "type": "string", "maxLength": 70, "nullable": true }, "attribute16": { "type": "string", "maxLength": 70, "nullable": true }, "attribute15": { "type": "string", "maxLength": 70, "nullable": true }, "attribute25": { "type": "string", "maxLength": 70, "nullable": true }, "attribute24": { "type": "string", "maxLength": 70, "nullable": true }, "attribute23": { "type": "string", "maxLength": 70, "nullable": true }, "attribute22": { "type": "string", "maxLength": 70, "nullable": true }, "attribute21": { "type": "string", "maxLength": 70, "nullable": true }, "attribute20": { "type": "string", "maxLength": 70, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 70, "nullable": true }, "attribute28": { "type": "string", "maxLength": 70, "nullable": true }, "attribute27": { "type": "string", "maxLength": 70, "nullable": true }, "attribute26": { "type": "string", "maxLength": 70, "nullable": true }, "attribute36": { "type": "string", "maxLength": 70, "nullable": true }, "quoteUniqueName": { "type": "string", "maxLength": 255 }, "attribute35": { "type": "string", "maxLength": 70, "nullable": true }, "attribute34": { "type": "string", "maxLength": 70, "nullable": true }, "attribute33": { "type": "string", "maxLength": 70, "nullable": true }, "attribute32": { "type": "string", "maxLength": 70, "nullable": true }, "attribute31": { "type": "string", "maxLength": 70, "nullable": true }, "attribute30": { "type": "string", "maxLength": 70, "nullable": true }, "attribute39": { "type": "string", "maxLength": 70, "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "maxLength": 70, "nullable": true }, "attribute37": { "type": "string", "maxLength": 70, "nullable": true }, "attribute47": { "type": "string", "maxLength": 70, "nullable": true }, "attribute46": { "type": "string", "maxLength": 70, "nullable": true }, "attribute45": { "type": "string", "maxLength": 70, "nullable": true }, "attribute44": { "type": "string", "maxLength": 70, "nullable": true }, "attribute43": { "type": "string", "maxLength": 70, "nullable": true }, "attribute42": { "type": "string", "maxLength": 70, "nullable": true }, "attribute41": { "type": "string", "maxLength": 70, "nullable": true }, "attribute40": { "type": "string", "maxLength": 70, "nullable": true }, "attribute49": { "type": "string", "maxLength": 70, "nullable": true }, "contractUniqueName": { "type": "string", "maxLength": 255 }, "attribute48": { "type": "string", "maxLength": 70, "nullable": true }, "attribute50": { "type": "string", "maxLength": 70, "nullable": true }, "totalAmount": { "type": "number" }, "attribute100": { "type": "string", "maxLength": 70, "nullable": true }, "attribute58": { "type": "string", "maxLength": 70, "nullable": true }, "attribute57": { "type": "string", "maxLength": 70, "nullable": true }, "attribute56": { "type": "string", "maxLength": 70, "nullable": true }, "attribute55": { "type": "string", "maxLength": 70, "nullable": true }, "attribute54": { "type": "string", "maxLength": 70, "nullable": true }, "attribute53": { "type": "string", "maxLength": 70, "nullable": true }, "attribute52": { "type": "string", "maxLength": 70, "nullable": true }, "validationState": { "type": "string", "maxLength": 255, "enum": [ "NOT_VALIDATED", "AUTO_VALIDATED", "AUTO_REJECTED", "VALIDATED", "REJECTED" ] }, "attribute51": { "type": "string", "maxLength": 70, "nullable": true }, "attribute59": { "type": "string", "maxLength": 70, "nullable": true }, "attribute61": { "type": "string", "maxLength": 70, "nullable": true }, "attribute60": { "type": "string", "maxLength": 70, "nullable": true }, "attribute69": { "type": "string", "maxLength": 70, "nullable": true }, "attribute68": { "type": "string", "maxLength": 70, "nullable": true }, "attribute67": { "type": "string", "maxLength": 70, "nullable": true }, "attribute66": { "type": "string", "maxLength": 70, "nullable": true }, "attribute65": { "type": "string", "maxLength": 70, "nullable": true }, "attribute64": { "type": "string", "maxLength": 70, "nullable": true }, "attribute63": { "type": "string", "maxLength": 70, "nullable": true }, "attribute62": { "type": "string", "maxLength": 70, "nullable": true }, "quantity": { "type": "number" }, "attribute72": { "type": "string", "maxLength": 70, "nullable": true }, "attribute71": { "type": "string", "maxLength": 70, "nullable": true }, "attribute70": { "type": "string", "maxLength": 70, "nullable": true }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "attribute79": { "type": "string", "maxLength": 70, "nullable": true }, "attribute78": { "type": "string", "maxLength": 70, "nullable": true }, "attribute77": { "type": "string", "maxLength": 70, "nullable": true }, "attribute76": { "type": "string", "maxLength": 70, "nullable": true }, "attribute75": { "type": "string", "maxLength": 70, "nullable": true }, "attribute74": { "type": "string", "maxLength": 70, "nullable": true }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "maxLength": 70, "nullable": true } } }, "ClaimLineItemAttributeMeta": { "title": "ClaimLineItemAttributeMeta", "description": "The type code is CLLIAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "claimId": { "type": "integer" }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ClaimRecord": { "title": "ClaimRecord", "description": "The type code is CLR", "type": "object", "properties": { "sourceId": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "externalRef": { "type": "string", "maxLength": 255 }, "itemCount": { "type": "integer" }, "claimType": { "type": "string", "maxLength": 255 }, "totalAmount": { "type": "number" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "validAfter": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "REVOKED" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ClaimType": { "title": "ClaimType", "description": "The type code is CLT.", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "sheetName": { "type": "string", "maxLength": 255 }, "configuration": { "type": "object", "nullable": true, "properties": { "columns": { "type": "object", "additionalProperties": { "type": "object", "properties": { "name": { "type": "string" }, "fieldFormatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "canEdit": { "type": "boolean" } } }, "properties": { "sku": { "type": "object", "nullable": true, "properties": { "name": { "type": "string", "nullable": true }, "fieldFormatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE", null ], "nullable": true }, "canEdit": { "type": "boolean" } } } } } } }, "allocationFormulaName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "validationStateElementName": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ClusterNode": { "title": "ClusterNode", "description": "The type code is CN", "type": "object", "properties": { "typedId": { "type": "string" }, "upgradeFailoverServerRoles": { "type": "string", "maxLength": 255 }, "hostInfo": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "lastSeenDate": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "padataLoadPartitions": { "type": "array", "items": { "type": "string" } }, "lastJoinDate": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "serverRoles": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "calcPartitions": { "type": "string", "maxLength": 255 }, "jettyHost": { "type": "string", "maxLength": 255 }, "maintenanceMode": { "type": "boolean" }, "jettyPort": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Compensation": { "type": "object", "title": "Compensation", "description": "The Compensation object. The type code is CO.", "properties": { "outputs": { "type": "array", "description": "Header results calculated for the Compensation Plan by the compensation header logic. Usually a summary / overall results for the whole agreement.", "nullable": true, "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "headerText": { "type": "string", "nullable": true }, "successfulCalculationMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_UNDELETABLE_STATUS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "endDate": { "description": "The last day of validity.", "type": "string", "nullable": true }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "inputs": { "type": "array", "description": "Custom header input fields, created by the compensation header logic. It is used by the user to enter values/conditions needed to calculate the results.", "nullable": true, "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "type": { "type": "string" }, "value": { "type": "object", "nullable": true }, "valueHint": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean", "nullable": true }, "filter": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "parameterGroup": { "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "labelTranslations": { "type": "string", "nullable": true }, "addUnknownValues": { "type": "boolean", "nullable": true }, "typedId": { "type": "string", "nullable": true }, "alwaysEditable": { "type": "boolean", "nullable": true }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "nullable": true, "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "readOnlyLineItemClass": { "type": "string" }, "compensationHeaderType": { "type": "string", "nullable": true }, "serverMessagesExtended": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "message": { "type": "string" } } } }, "compensationRecordSetLabel": { "type": "string", "maxLength": 255, "nullable": true }, "payoutDate": { "description": "The date on which the seller expects to receive the compensation money. If there are more payout periods during the Contract duration, such dates will be specified via custom input fields.", "type": "string", "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object" } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "parentId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "containsProductImage": { "type": "boolean" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "payoutDate": { "type": "string", "format": "date-time", "nullable": true }, "calculationBaseJson": { "type": "string" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "anyOf": [ { "format": "date-time" }, { "format": "date" } ], "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] } }, "dateDimFieldName": { "type": "string" } } }, "simulationType": { "type": "string" }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "compensationConditionType": { "type": "string" }, "compensationConditionTypeLabel": { "type": "string" } } } }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "creationWorkflowCurrentStep": { "type": "integer", "description": "The order of the current active creation step. The first step is the number 0.", "nullable": true }, "rootUniqueName": { "type": "string" }, "originUniqueName": { "type": "string", "nullable": true }, "targetDate": { "description": "Stands for a \"calculation date\" – a date which will be used to distinguish which data are used for calculation. Its value is used automatically by the system when retrieving proper versions of Company Parameters. You can also use it the logic to select correct data which change in time.", "type": "string", "nullable": true }, "customerGroup": { "type": "object", "description": "A selection of customers (usually based on the customer hierarchy) the plan is intended for.", "nullable": true }, "ioMeta": { "anyOf": [ { "type": "string" }, { "type": "object" } ] }, "originDeleted": { "type": "boolean" }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255, "description": "ID of the plan, generated by the system. The prefix of the uniqueName can be modified in Administration > Configuration > System Configuration > **Advanced Configuration Options**." }, "serverMessages": { "type": "array", "nullable": true, "items": { "type": "string" } }, "creationWorkflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "INPROGRESS", "FINISHED", null ], "nullable": true }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "conditionTypeClass": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "startDate": { "description": "The first day of validity of conditions negotiated on the Compensation Plan header & lines.", "type": "string", "nullable": true }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "originClicId": { "type": "integer", "nullable": true }, "renderInfo": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "signature": { "type": "object", "nullable": true, "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "delivered", "signed", "completed", "declined", "voided", "processing", "error", "cancelling" ] }, "sentDateTime": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "statusChangedDateTime": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "customerName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "sender": { "type": "integer" }, "senderName": { "type": "string" }, "templateName": { "type": "string" }, "note": { "type": "string" }, "voidedReason": { "type": "string" }, "error": { "type": "string" }, "history": { "type": "array", "items": { "type": "object" } } } }, "creationWorkflowStepCount": { "type": "integer", "description": "The total number of all creation steps.", "nullable": true }, "sellerGroup": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true }, { "type": "object", "nullable": true } ], "description": "A selection of sellers (usually based on the seller hierarchy) the plan is intended for." }, "compensationRecordSetId": { "type": "integer", "nullable": true }, "creationWorkflowStepLabel": { "type": "string", "maxLength": 255, "description": "The label of the current creation workflow step.", "nullable": true }, "formulaElementGroupReadOnly": { "type": "string" }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "formulaElementGroup": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "additionalInfo4": { "type": "string", "maxLength": 255, "nullable": true }, "additionalInfo3": { "type": "string", "maxLength": 255, "nullable": true }, "refreshInputs": { "type": "boolean" }, "additionalInfo2": { "type": "number", "nullable": true }, "additionalInfo1": { "type": "number", "nullable": true }, "numberOfAttachments": { "type": "integer" }, "compensationStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "OPEN", "CLOSED", "REVOKED", "SUPERSEDED", "INVALIDATED" ], "description": "Status of the Compensation Plan." }, "originLabel": { "type": "string", "maxLength": 255, "nullable": true }, "simulationType": { "type": "string", "maxLength": 255, "nullable": true }, "label": { "type": "string", "maxLength": 255, "description": "The name of the Compensation Plan entered by the user." }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "simulationSet": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "calculationWithErrorsMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_UNDELETABLE_STATUS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "approvalRequiredEmailAttachmentsJson": { "type": "string", "nullable": true }, "viewState": { "type": "object", "description": "Contains some (limited) information about the state of the front-end application. See [View State](https://pricefx.atlassian.net/wiki/spaces/KB/pages/3887824922).", "nullable": true, "properties": { "gridViewState": { "type": "string", "nullable": true }, "openFolders": { "type": "array", "nullable": true, "items": { "type": "string" } }, "selectedNodes": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, "prevRev": { "type": "string", "nullable": true }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string", "nullable": true }, "lastUpdateBy": { "type": "integer" } } }, "CompensationAccrualRecord": { "type": "object", "title": "CompensationAccrualRecord", "description": "The CompensationAccrualRecord object. The type code is COAR.", "properties": { "compensationRecordUN": { "maxLength": 255, "type": "string" }, "compensationType": { "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "endDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] }, "label": { "type": "string" }, "lastStatusUpdateDate": { "format": "date-time", "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "payoutDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] }, "startDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ] }, "status": { "maxLength": 255, "type": "string" }, "type": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "type": "number" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "type": "number" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "type": "number" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "attribute22": { "type": "number" }, "attribute23": { "type": "number" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" } } }, "CompensationAttributeMeta": { "title": "CompensationAttributeMeta", "description": "The type code is COAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationConditionType": { "title": "CompensationConditionType", "description": "The CompensationConditionType object. The type code is COCT.

\nDefines which logic will be used to calculate particular Compensation Condition Type and what parameters (in attributeX fields) will be available to the logic when it executes.\n\nWhether you use a different logic for various Compensation Condition Types or the same logic, depends on how much different the processes behind the various Compensation Condition Types are.

", "type": "object", "properties": { "uniqueName": { "maxLength": 255, "type": "string", "description": "A unique identifier name, given by an implementation engineer.\n" }, "typedId": { "type": "string" }, "label": { "maxLength": 255, "type": "string", "description": "A name of the Compensation Condition Type, visible to business users when selecting a type of new line on a Compensation Plan." }, "formulaName": { "maxLength": 255, "type": "string", "description": "A compensation condition logic. This logic is used to calculate all following:\n\n- COLI – compensation line item – for draft / editable document\n\n- COLI – compensation line item – for approved/read-only document\n\n- COR – Compensation Record", "nullable": true }, "waterfallElement": { "maxLength": 255, "type": "string", "description": "Stands for a name of a waterfall element which will contain the compensation money amount calculated by this compensation condition type.\n\nThe actual usage of this setting is up to the implementation engineer who has to use this value then in another logic (e.g. in the Quote Line Item logic).", "nullable": true }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "lastUpdateBy": { "type": "integer" }, "userGroupEdit": { "maxLength": 255, "type": "string", "nullable": true }, "userGroupViewDetails": { "maxLength": 255, "type": "string", "nullable": true }, "version": { "type": "integer" }, "attribute1": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute2": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute3": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute4": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute5": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute6": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute7": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute8": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute9": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute10": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute11": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute12": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute13": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute14": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute15": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute16": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute17": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute18": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute19": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute20": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute21": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute22": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute23": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute24": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute25": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute26": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute27": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute28": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute29": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute30": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] } } }, "CompensationCondTypeAttributeMeta": { "title": "CompensationCondTypeAttributeMeta", "description": "The type code is COCTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string", "nullable": true }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255, "nullable": true }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationHeaderType": { "title": "CompensationHeaderType", "description": "The Compensation Header Type object. The type code is COHT.", "type": "object", "properties": { "configuration": { "type": "object", "description": "A configuration (as JSON string) of the detail page. You can configure e.g., the additional tabs on Compensation Plan detail page, which will show information in form of a dashboard. See [Detail Page Layout and Dynamic Tabs](https://pricefx.atlassian.net/wiki/spaces/KB/pages/3980492805) for more details.", "nullable": true, "properties": { "additionalProperties": { "type": "object" } } }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "headerFormulaName": { "maxLength": 255, "type": "string", "description": "A name of the logic used for building inputs and calculating results for the Compensation Plan header, but can also manipulate the items and folders." }, "label": { "maxLength": 255, "type": "string", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "scRecordWorkflowFormulaName": { "maxLength": 255, "type": "string", "description": "A name of the approval workflow logic, which will build the approval steps for the compensation records." }, "scTypeFilterFormulaName": { "maxLength": 255, "type": "string", "description": "A name of the logic which will be used to filter the available Compensation Condition Types, while the user is adding a new item to the Compensation Plan document.", "nullable": true }, "typedId": { "type": "string" }, "uniqueName": { "maxLength": 255, "type": "string", "description": "A unique identification of this type. This name will be used in the Compensation Plan document as a foreign key, to identify the compensation header type used." }, "userGroupEdit": { "maxLength": 255, "type": "string", "nullable": true }, "userGroupViewDetails": { "maxLength": 255, "type": "string", "nullable": true }, "version": { "type": "integer" }, "workflowFormulaName": { "maxLength": 255, "type": "string", "description": "A name of the approval workflow logic, which will build the approval steps for the Compensation Plan document.", "nullable": true }, "attribute1": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute2": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute3": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute4": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute5": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute6": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute7": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute8": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute9": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute10": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute11": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute12": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute13": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute14": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute15": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute16": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute17": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute18": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute19": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute20": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute21": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute22": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute23": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute24": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute25": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute26": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute27": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute28": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute29": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute30": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] } } }, "CompensationHeaderTypeAttributeMeta": { "title": "CompensationHeaderTypeAttributeMeta", "description": "The type code is COHTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationLineItem": { "title": "CompensationLineItem", "description": "The type code is COLI", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "object" } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "typedId": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "payoutDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "compensationConditionType": { "type": "string" }, "treeLabel": { "type": "string" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "lineId": { "type": "string", "maxLength": 255 }, "simulationType": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "folder": { "type": "boolean" }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "createdBy": { "type": "integer" }, "compensationConditionTypeLabel": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationRecord": { "title": "CompensationRecord", "description": "The `CompensationRecord` object. The type code is COR.", "type": "object", "properties": { "typedId": { "type": "string" }, "resultPrice": { "type": "number", "nullable": true }, "endDate": { "anyOf": [ { "format": "date-time" }, { "format": "date" } ], "type": "string" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED", null ], "nullable": true }, "intgStatus": { "type": "string", "maxLength": 255, "nullable": true }, "payoutDate": { "anyOf": [ { "format": "date-time" }, { "format": "date" } ], "type": "string" }, "priceChangePct": { "type": "number", "nullable": true }, "attribute83": { "type": "string", "maxLength": 70, "nullable": true }, "attribute82": { "type": "string", "maxLength": 70, "nullable": true }, "intgStatusDetails": { "type": "string", "maxLength": 255, "nullable": true }, "attribute81": { "type": "string", "maxLength": 70, "nullable": true }, "attribute80": { "type": "string", "maxLength": 70, "nullable": true }, "sourceIdNoRev": { "type": "string" }, "rank": { "type": "integer" }, "attribute89": { "type": "string", "maxLength": 70, "nullable": true }, "attribute88": { "type": "string", "maxLength": 70, "nullable": true }, "sku": { "type": "string", "maxLength": 255, "nullable": true }, "attribute87": { "type": "string", "maxLength": 70, "nullable": true }, "attribute86": { "type": "string", "maxLength": 70, "nullable": true }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "nullable": true }, { "type": "string", "nullable": true }, { "type": "integer", "nullable": true }, { "type": "number", "nullable": true } ] }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "nullable": true, "items": { "type": "string" } }, "alertMessage": { "type": "string", "nullable": true }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW", null ], "nullable": true }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string", "nullable": true }, "resultType": { "type": "string" }, "cssProperties": { "type": "string", "nullable": true }, "userGroup": { "type": "string", "nullable": true }, "resultGroup": { "type": "string", "nullable": true }, "overrideValueOptions": { "type": "array", "nullable": true, "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string", "nullable": true }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string", "nullable": true } } } }, "attribute85": { "type": "string", "maxLength": 70, "nullable": true }, "attribute84": { "type": "string", "maxLength": 70, "nullable": true }, "unitOfMeasure": { "type": "string", "maxLength": 255, "nullable": true }, "agreementTerms": { "type": "object", "additionalProperties": { "type": "object" }, "properties": { "Target": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true } ] }, "Compensation": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "integer", "nullable": true } ] }, "Payment Period": { "type": "string" } } }, "targetDate": { "type": "string", "format": "date-time", "nullable": true }, "allowedOverrides": { "type": "string", "maxLength": 1300, "nullable": true }, "version": { "type": "integer" }, "alerts": { "type": "string", "nullable": true }, "attribute9": { "type": "string", "maxLength": 70, "nullable": true }, "attribute94": { "type": "string", "maxLength": 70, "nullable": true }, "attribute8": { "type": "string", "maxLength": 70, "nullable": true }, "attribute93": { "type": "string", "maxLength": 70, "nullable": true }, "attribute92": { "type": "string", "maxLength": 70, "nullable": true }, "attribute91": { "type": "string", "maxLength": 70, "nullable": true }, "attribute5": { "type": "string", "maxLength": 70, "nullable": true }, "attribute90": { "type": "string", "maxLength": 70, "nullable": true }, "attribute4": { "type": "string", "maxLength": 70, "nullable": true }, "attribute7": { "type": "string", "maxLength": 70, "nullable": true }, "attribute6": { "type": "string", "maxLength": 70, "nullable": true }, "attribute1": { "type": "string", "maxLength": 70, "nullable": true }, "attribute14": { "type": "string", "maxLength": 70, "nullable": true }, "messages": { "type": "array", "items": { "type": "string" } }, "attribute13": { "type": "string", "maxLength": 70, "nullable": true }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "type": "string", "maxLength": 70, "nullable": true }, "attribute12": { "type": "string", "maxLength": 70, "nullable": true }, "attribute2": { "type": "string", "maxLength": 70, "nullable": true }, "attribute11": { "type": "string", "maxLength": 70, "nullable": true }, "attribute99": { "type": "string", "maxLength": 70, "nullable": true }, "attribute10": { "type": "string", "maxLength": 70, "nullable": true }, "attribute98": { "type": "string", "maxLength": 70, "nullable": true }, "attribute97": { "type": "string", "maxLength": 70, "nullable": true }, "startDate": { "anyOf": [ { "format": "date-time", "type": "string", "nullable": true }, { "format": "date", "type": "string", "nullable": true } ], "type": "string" }, "attribute96": { "type": "string", "maxLength": 70, "nullable": true }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "APPROVED", "REVOKED", "INVALIDATED" ] }, "attribute95": { "type": "string", "maxLength": 70, "nullable": true }, "formulaName": { "type": "string", "maxLength": 255 }, "itemExtensions": { "type": "object", "nullable": true }, "agreementClass": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 70, "nullable": true }, "attribute18": { "type": "string", "maxLength": 70, "nullable": true }, "attribute17": { "type": "string", "maxLength": 70, "nullable": true }, "attribute16": { "type": "string", "maxLength": 70, "nullable": true }, "attribute15": { "type": "string", "maxLength": 70, "nullable": true }, "sellerName": { "type": "string" }, "manual": { "type": "boolean" }, "calculationDate": { "type": "string", "format": "date-time" }, "manualOverrides": { "type": "string", "nullable": true }, "calculationBaseAsAdvancedFilterCriteria": { "type": "object", "nullable": true, "additionalProperties": { "type": "object", "nullable": true }, "properties": { "_constructor": { "type": "string", "nullable": true } } }, "parentTypedId": { "type": "string" }, "attribute25": { "type": "string", "maxLength": 70, "nullable": true }, "submittedByName": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 70, "nullable": true }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 70, "nullable": true }, "attribute22": { "type": "string", "maxLength": 70, "nullable": true }, "attribute21": { "type": "string", "maxLength": 70, "nullable": true }, "attribute20": { "type": "string", "maxLength": 70, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object" } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "approvalRequiredEmailAttachments": { "type": "array", "items": {} }, "attribute29": { "type": "string", "maxLength": 70, "nullable": true }, "compensationStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "OPEN", "CLOSED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "attribute28": { "type": "string", "maxLength": 70, "nullable": true }, "attribute27": { "type": "string", "maxLength": 70, "nullable": true }, "attribute26": { "type": "string", "maxLength": 70, "nullable": true }, "lineId": { "type": "string", "maxLength": 255 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "attribute36": { "type": "string", "maxLength": 70, "nullable": true }, "attribute35": { "type": "string", "maxLength": 70, "nullable": true }, "attribute34": { "type": "string", "maxLength": 70, "nullable": true }, "attribute33": { "type": "string", "maxLength": 70, "nullable": true }, "attribute32": { "type": "string", "maxLength": 70, "nullable": true }, "attribute31": { "type": "string", "maxLength": 70, "nullable": true }, "intgStatusErpReference": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 70, "nullable": true }, "sourceId": { "type": "string", "maxLength": 255 }, "seller": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } }, "key2": { "type": "string" }, "attribute39": { "type": "string", "maxLength": 70, "nullable": true }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "maxLength": 70, "nullable": true }, "attribute37": { "type": "string", "maxLength": 70, "nullable": true }, "compensationHeaderType": { "type": "string" }, "compensationRecordSetLabel": { "type": "string", "maxLength": 255 }, "deniedByName": { "type": "string" }, "attribute47": { "type": "string", "maxLength": 70, "nullable": true }, "attribute46": { "type": "string", "maxLength": 70, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "approvedByName": { "type": "string" }, "attribute45": { "type": "string", "maxLength": 70, "nullable": true }, "attribute44": { "type": "string", "maxLength": 70, "nullable": true }, "attribute43": { "type": "string", "maxLength": 70, "nullable": true }, "attribute42": { "type": "string", "maxLength": 70, "nullable": true }, "attribute41": { "type": "string", "maxLength": 70, "nullable": true }, "attribute40": { "type": "string", "maxLength": 70, "nullable": true }, "priceChange": { "type": "number" }, "agreementInputs": { "type": "array", "items": { "type": "object" } }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "attribute49": { "type": "string", "maxLength": 70, "nullable": true }, "attribute48": { "type": "string", "maxLength": 70, "nullable": true }, "attribute50": { "type": "string", "maxLength": 70, "nullable": true }, "attribute100": { "type": "string", "maxLength": 70, "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255 }, "calculatedResultPrice": { "type": "number" }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "type": "string", "maxLength": 70, "nullable": true }, "attribute57": { "type": "string", "maxLength": 70, "nullable": true }, "attribute56": { "type": "string", "maxLength": 70, "nullable": true }, "attribute55": { "type": "string", "maxLength": 70, "nullable": true }, "productFilterString": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "attribute54": { "type": "string", "maxLength": 70, "nullable": true }, "attribute53": { "type": "string", "maxLength": 70, "nullable": true }, "attribute52": { "type": "string", "maxLength": 70, "nullable": true }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "attribute51": { "type": "string", "maxLength": 70, "nullable": true }, "calculationBaseJson": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time" }, "recordSetLabel": { "type": "string" }, "attribute59": { "type": "string", "maxLength": 70, "nullable": true }, "description": { "type": "string" }, "compensationRecordSetId": { "type": "integer" }, "attribute61": { "type": "string", "maxLength": 70, "nullable": true }, "attribute60": { "type": "string", "maxLength": 70, "nullable": true }, "customerFilterString": { "type": "string" }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "maxLength": 70, "nullable": true }, "formulaElementGroup": { "type": "string" }, "attribute68": { "type": "string", "maxLength": 70, "nullable": true }, "attribute67": { "type": "string", "maxLength": 70, "nullable": true }, "calculatedWithErrorsMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "attribute66": { "type": "string", "maxLength": 70, "nullable": true }, "attribute65": { "type": "string", "maxLength": 70, "nullable": true }, "attribute64": { "type": "string", "maxLength": 70, "nullable": true }, "attribute63": { "type": "string", "maxLength": 70, "nullable": true }, "attribute62": { "type": "string", "maxLength": 70, "nullable": true }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "compensationConditionType": { "type": "string" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "calculatedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "agreementInputsAsMap": { "type": "object", "additionalProperties": { "type": "object" } }, "attribute72": { "type": "string", "maxLength": 70, "nullable": true }, "attribute71": { "type": "string", "maxLength": 70, "nullable": true }, "attribute70": { "type": "string", "maxLength": 70, "nullable": true }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "attribute79": { "type": "string", "maxLength": 70, "nullable": true }, "attribute78": { "type": "string", "maxLength": 70, "nullable": true }, "attribute77": { "type": "string", "maxLength": 70, "nullable": true }, "attribute76": { "type": "string", "maxLength": 70, "nullable": true }, "attribute75": { "type": "string", "maxLength": 70, "nullable": true }, "attribute74": { "type": "string", "maxLength": 70, "nullable": true }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "maxLength": 70, "nullable": true } } }, "CompensationRecordAttributeMeta": { "title": "CompensationRecordAttributeMeta", "description": "The type code is CORAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "compensationRecordSetId": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationReadOnlyLineItem": { "title": "CompensationReadOnlyLineItem", "description": "The type code is COROLI", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "typedId": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "payoutDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "compensationConditionType": { "type": "string" }, "treeLabel": { "type": "string" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "lineId": { "type": "string", "maxLength": 255 }, "simulationType": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "folder": { "type": "boolean" }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "createdBy": { "type": "integer" }, "compensationConditionTypeLabel": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CompensationRecordSet": { "title": "CompensationRecordSet", "description": "The type code is CORS", "type": "object", "properties": { "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "updatedBy": { "type": "integer" }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "writeOnlyChangedItems": { "type": "boolean" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "recordSetId": { "type": "integer" }, "id": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "CompensationRecordSetCalculation": { "title": "CompensationRecordSetCalculation", "description": "The CompensationRecordSetCalculation object. The type code is CORSC.", "type": "object", "properties": { "calculationType": { "type": "string", "nullable": true, "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "locale": { "type": "string", "maxLength": 255, "nullable": true }, "compensationRecordSet": { "type": "object", "nullable": true, "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "targetDate": { "type": "string", "nullable": true, "format": "date-time" }, "label": { "type": "string" }, "locale": { "type": "string", "nullable": true }, "calculationMessages": { "type": "string", "nullable": true }, "numberOfItems": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "updatedBy": { "type": "integer" }, "updateDate": { "anyOf": [ { "type": "string", "nullable": true, "format": "date-time" }, { "type": "string", "nullable": true, "format": "date" } ] }, "recordSetId": { "type": "integer" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "calculationStartDate": { "type": "string", "nullable": true }, "calculationDate": { "type": "string", "nullable": true }, "id": { "type": "integer" } } }, "calculationDate": { "anyOf": [ { "type": "string", "nullable": true, "format": "date-time" }, { "type": "string", "nullable": true, "format": "date" } ] }, "compensationRecordSetLabel": { "type": "string", "maxLength": 255 }, "compensationRecordSetId": { "type": "integer" }, "valid": { "type": "boolean" }, "sortBy": { "type": "string", "nullable": true, "maxLength": 255 }, "adhocCalculation": { "type": "object", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "calculationMessages": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "nullable": true, "format": "date-time" }, "shouldSubmit": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "incremental": { "type": "boolean" }, "version": { "type": "integer" }, "dtoFilter": { "type": "object", "nullable": true, "additionalProperties": { "anyOf": [ { "type": "object" }, { "type": "string" }, { "type": "array" } ] } }, "isDefault": { "type": "boolean" }, "incCalculationDate": { "anyOf": [ { "type": "string", "nullable": true, "format": "date-time" }, { "type": "string", "nullable": true, "format": "date" } ] }, "createdBy": { "type": "integer" }, "calculationStartDate": { "anyOf": [ { "type": "string", "nullable": true, "format": "date-time" }, { "type": "string", "nullable": true, "format": "date" } ] }, "calculationConfig": { "nullable": true, "type": "object", "properties": { "skuField": { "type": "string", "nullable": true }, "targetDateField": { "type": "string", "nullable": true }, "simulationSet": { "type": "string", "nullable": true }, "formulaName": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "nullable": true, "format": "date-time" }, "feederFormulaName": { "type": "string", "nullable": true }, "feederInputParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "formulaName": { "type": "string" }, "formulaDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "key": { "type": "boolean" }, "selected": { "type": "boolean" }, "displayedInPriceShop": { "type": "boolean" } } } }, "targetFields": { "type": "array", "nullable": true, "items": { "type": "string" } } } }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "CompensationTree": { "title": "CompensationTree", "description": "The type code is COT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CalculationSchedule": { "title": "CalculationSchedule", "description": "The type code is CS.", "type": "object", "properties": { "period": { "type": "string", "maxLength": 255, "enum": [ "MINUTE", "HOUR", "DAY", "MONTH", "YEAR" ] }, "typedId": { "type": "string" }, "calculableTypedId": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "lastRunDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "calculableLabel": { "type": "string", "maxLength": 255 }, "interval": { "type": "integer" }, "parameters": { "type": "object", "properties": { "action": { "type": "string" } } }, "startDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ConditionRecordItem12Key": { "title": "ConditionRecordItem12Key", "type": "object", "description": "The type code is CRCI12.

\n\n**MassEditable**: no
\n**bulkLoadable**: no\n", "properties": { "key1": { "type": "string", "maxLength": 63 }, "key2": { "type": "string", "maxLength": 63 }, "typedId": { "type": "string" }, "key5": { "type": "string", "maxLength": 63 }, "key6": { "type": "string", "maxLength": 63 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "key3": { "type": "string", "maxLength": 63 }, "key4": { "type": "string", "maxLength": 63 }, "key9": { "type": "string", "maxLength": 63 }, "key7": { "type": "string", "maxLength": 63 }, "validFrom": { "type": "string", "format": "date-time" }, "key8": { "type": "string", "maxLength": 63 }, "priceUnit": { "type": "number", "nullable": true }, "unitOfMeasure": { "type": "string", "maxLength": 255, "nullable": true }, "conditionRecordSetId": { "type": "integer" }, "key11": { "type": "string", "maxLength": 63 }, "version": { "type": "integer" }, "key10": { "type": "string", "maxLength": 63 }, "attribute9": { "maxLength": 255 }, "attribute8": { "maxLength": 255 }, "attribute5": { "maxLength": 255 }, "attribute4": { "maxLength": 255 }, "attribute7": { "maxLength": 255 }, "attribute6": { "maxLength": 255 }, "attribute1": { "maxLength": 255 }, "attribute14": { "maxLength": 255 }, "conditionValue": { "type": "number", "nullable": true }, "attribute13": { "maxLength": 255 }, "integrationStatus": { "type": "integer" }, "attribute3": { "maxLength": 255 }, "attribute12": { "maxLength": 255 }, "attribute2": { "maxLength": 255 }, "attribute11": { "maxLength": 255 }, "attribute10": { "maxLength": 255 }, "attribute19": { "maxLength": 255 }, "attribute18": { "maxLength": 255 }, "attribute17": { "maxLength": 255 }, "attribute16": { "maxLength": 255 }, "attribute15": { "maxLength": 255 }, "key12": { "type": "string", "maxLength": 63 }, "createdByObj": { "type": "string", "maxLength": 255, "nullable": true }, "attribute25": { "maxLength": 255 }, "attribute24": { "maxLength": 255 }, "currency": { "type": "string", "maxLength": 255, "nullable": true }, "attribute23": { "maxLength": 255 }, "attribute22": { "maxLength": 255 }, "attribute21": { "maxLength": 255 }, "attribute20": { "maxLength": 255 }, "validTo": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "maxLength": 255 }, "attribute28": { "maxLength": 255 }, "attribute27": { "maxLength": 255 }, "attribute26": { "maxLength": 255 }, "lastUpdatedByObj": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "tableId": { "type": "integer", "nullable": true }, "attribute30": { "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "ConditionRecordItem3Key": { "title": "ConditionRecordItem3Key", "type": "object", "description": "The type code is CRCI3.

\n\n**MassEditable**: no
\n**bulkLoadable**: no\n", "properties": { "key1": { "type": "string", "maxLength": 63 }, "key2": { "type": "string", "maxLength": 63 }, "typedId": { "type": "string" }, "key5": { "type": "string", "maxLength": 63 }, "key6": { "type": "string", "maxLength": 63 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "key3": { "type": "string", "maxLength": 63 }, "key4": { "type": "string", "maxLength": 63 }, "key9": { "type": "string", "maxLength": 63 }, "key7": { "type": "string", "maxLength": 63 }, "validFrom": { "type": "string", "format": "date-time" }, "key8": { "type": "string", "maxLength": 63 }, "priceUnit": { "type": "number", "nullable": true }, "unitOfMeasure": { "type": "string", "maxLength": 255, "nullable": true }, "conditionRecordSetId": { "type": "integer" }, "key11": { "type": "string", "maxLength": 63 }, "version": { "type": "integer" }, "key10": { "type": "string", "maxLength": 63 }, "attribute9": { "maxLength": 255 }, "attribute8": { "maxLength": 255 }, "attribute5": { "maxLength": 255 }, "attribute4": { "maxLength": 255 }, "attribute7": { "maxLength": 255 }, "attribute6": { "maxLength": 255 }, "attribute1": { "maxLength": 255 }, "attribute14": { "maxLength": 255 }, "conditionValue": { "type": "number", "nullable": true }, "attribute13": { "maxLength": 255 }, "integrationStatus": { "type": "integer" }, "attribute3": { "maxLength": 255 }, "attribute12": { "maxLength": 255 }, "attribute2": { "maxLength": 255 }, "attribute11": { "maxLength": 255 }, "attribute10": { "maxLength": 255 }, "attribute19": { "maxLength": 255 }, "attribute18": { "maxLength": 255 }, "attribute17": { "maxLength": 255 }, "attribute16": { "maxLength": 255 }, "attribute15": { "maxLength": 255 }, "key12": { "type": "string", "maxLength": 63 }, "createdByObj": { "type": "string", "maxLength": 255, "nullable": true }, "attribute25": { "maxLength": 255 }, "attribute24": { "maxLength": 255 }, "currency": { "type": "string", "maxLength": 255, "nullable": true }, "attribute23": { "maxLength": 255 }, "attribute22": { "maxLength": 255 }, "attribute21": { "maxLength": 255 }, "attribute20": { "maxLength": 255 }, "validTo": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "maxLength": 255 }, "attribute28": { "maxLength": 255 }, "attribute27": { "maxLength": 255 }, "attribute26": { "maxLength": 255 }, "lastUpdatedByObj": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "tableId": { "type": "integer", "nullable": true }, "attribute30": { "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "ConditionRecordItemAttributeMeta": { "title": "ConditionRecordItemAttributeMeta", "type": "object", "description": "The type code is CRCIM.", "properties": { "cssProperties": { "type": "string", "maxLength": 255, "nullable": true }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "hidden": { "type": "boolean" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string", "nullable": true }, "description": { "type": "string", "maxLength": 1000, "nullable": true }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "conditionRecordSetId": { "type": "integer" }, "manual": { "type": "boolean" }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255, "nullable": true }, "inputAttribute": { "type": "boolean" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255, "nullable": true }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "userGroup": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ConditionRecordSet": { "title": "ConditionRecordSet", "type": "object", "description": "The type code is CRCS.

\n**MassEditable**: no
\n**bulkLoadable**: no", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "updatedBy": { "type": "integer" }, "keySize": { "type": "integer", "description": "The number of key fields (key1..key12). Cannot be changed once the Condition Record Set is created." }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255, "nullable": true }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "id": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Contract": { "title": "Contract", "description": "The type code is CT.", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "headerText": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "serverMessagesExtended": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" } } } }, "externalRef": { "type": "string", "maxLength": 255 }, "deniedByName": { "type": "string" }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object" } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "parentId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "priceRecordId": { "type": "integer" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "calculationBaseJson": { "type": "string" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "contractTermType": { "type": "string" } } } }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "approvedByName": { "type": "string" }, "creationWorkflowCurrentStep": { "type": "integer" }, "rootUniqueName": { "type": "string" }, "originUniqueName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "customerGroup": { "type": "object" }, "ioMeta": { "type": "string" }, "originDeleted": { "type": "boolean" }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "serverMessages": { "type": "array", "items": { "type": "string" } }, "creationWorkflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "INPROGRESS", "FINISHED" ] }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "originClicId": { "type": "integer" }, "renderInfo": { "type": "object", "additionalProperties": { "type": "string" } }, "signature": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "delivered", "signed", "completed", "declined", "voided", "processing", "error", "cancelling" ] }, "sentDateTime": { "type": "string" }, "statusChangedDateTime": { "type": "string" }, "customerName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "sender": { "type": "integer" }, "senderName": { "type": "string" }, "templateName": { "type": "string" }, "note": { "type": "string" }, "voidedReason": { "type": "string" }, "error": { "type": "string" }, "history": { "type": "array", "items": { "type": "object" } } } }, "creationWorkflowStepCount": { "type": "integer" }, "creationWorkflowStepLabel": { "type": "string", "maxLength": 255 }, "submittedByName": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "additionalInfo4": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "refreshInputs": { "type": "boolean" }, "additionalInfo2": { "type": "number" }, "additionalInfo1": { "type": "number" }, "contractStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "numberOfAttachments": { "type": "integer" }, "originLabel": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "productGroup": { "type": "object" }, "createdBy": { "type": "integer" }, "approvalRequiredEmailAttachmentsJson": { "type": "string" }, "viewState": { "type": "object", "properties": { "gridViewState": { "type": "string" }, "openFolders": { "type": "array", "items": { "type": "string" } }, "selectedNodes": { "type": "array", "items": { "type": "string" } } } }, "prevRev": { "type": "string" }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "ContractPriceRecord": { "title": "ContractPriceRecord", "type": "object", "description": "The type code is CPR.", "properties": { "sourceId": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string", "maxLength": 255 }, "sourceIdNoRev": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "priority": { "type": "integer" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "REVOKED", "INVALIDATED" ] }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "expiryDate": { "type": "string", "format": "date" }, "customerId": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "validAfter": { "type": "string", "format": "date" }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lineId": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "createdBy": { "type": "integer" }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "ContractCalculation": { "title": "ContractCalculation", "description": "The type code is CTC.", "type": "object", "properties": { "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "shouldSubmit": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "valid": { "type": "boolean" }, "dtoFilter": { "type": "object", "additionalProperties": { "type": "object" } }, "isDefault": { "type": "boolean" }, "createdBy": { "type": "integer" }, "sortBy": { "type": "string", "maxLength": 255 }, "adhocCalculation": { "type": "object" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "calculationConfig": { "type": "object", "properties": { "skuField": { "type": "string" }, "targetDateField": { "type": "string" }, "simulationSet": { "type": "string" }, "formulaName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "feederFormulaName": { "type": "string" }, "feederInputParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "formulaName": { "type": "string" }, "formulaDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "key": { "type": "boolean" }, "selected": { "type": "boolean" }, "displayedInPriceShop": { "type": "boolean" } } } }, "resultFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "object" }, "source": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "GROUP_CONCAT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "system": { "type": "boolean" }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "deleted": { "type": "boolean" }, "dbTable": { "type": "string" }, "auxiliary": { "type": "boolean" }, "deployed": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "calculated": { "type": "boolean" }, "dbColumn": { "type": "string" }, "queryable": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "owningFC": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "allocationFields": { "type": "array", "items": { "type": "object" } }, "targetFields": { "type": "array", "items": { "type": "string" } } } }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "ContractAttributeMeta": { "title": "ContractAttributeMeta", "description": "The type code is CTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ContractLineItem": { "title": "ContractLineItem", "description": "The type code is CTLI", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "typedId": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "treeLabel": { "type": "string" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "lineId": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "priceRecordId": { "type": "integer" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "folder": { "type": "boolean" }, "contractTermType": { "type": "string" }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ContractMassUpdate": { "title": "ContractMassUpdate", "description": "The type code is CTMU", "type": "object", "properties": { "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "object", "properties": { "headerFilter": { "type": "object", "additionalProperties": { "type": "string" } }, "inputsLogic": { "type": "string" }, "headerInputsLogic": { "type": "string" }, "inputUpdateDefs": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldLabel": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "string" }, "desc": { "type": "string" }, "inputType": { "type": "string" } } } }, "headerInputUpdateDefs": { "type": "array", "items": { "type": "object" } }, "outputDefs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" } } } }, "inputDefs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" } } } }, "overridesLogic": { "type": "string" }, "headerOverridesLogic": { "type": "string" }, "inputsLogicParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "headerInputsLogicParams": { "type": "array", "items": { "type": "object" } }, "overridesLogicParams": { "type": "array", "items": { "type": "object" } }, "headerOverridesLogicParams": { "type": "array", "items": { "type": "object" } }, "errorModeType": { "type": "string", "enum": [ "ABORT", "SKIP" ] }, "userNotificationType": { "type": "string", "enum": [ "NONE", "EMAIL" ] }, "autoSubmit": { "type": "boolean" }, "createCopies": { "type": "boolean" }, "comment": { "type": "string" }, "customerGroup": { "type": "object", "additionalProperties": { "type": "string" } }, "productGroup": { "type": "object", "additionalProperties": { "type": "string" } }, "contractTermTypeFilter": { "type": "object", "additionalProperties": { "type": "string" } } } }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "templateName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "progress": { "type": "string", "maxLength": 255 }, "massUpdateType": { "type": "string", "maxLength": 255, "enum": [ "SIMULATION", "UPDATE" ] }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "ContractMassUpdateItem": { "title": "ContractMassUpdateItem", "description": "The type code is CTMUI", "type": "object", "properties": { "targetUniqueName": { "type": "string", "maxLength": 255 }, "item": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "targetLabel": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "massUpdateId": { "type": "integer" }, "sourceStatus": { "type": "string" }, "createdBy": { "type": "integer" }, "sourceItemLineId": { "type": "string", "maxLength": 255 }, "targetItemLineId": { "type": "string", "maxLength": 255 }, "sourceUniqueName": { "type": "string", "maxLength": 255 }, "targetStatus": { "type": "string" }, "rootItem": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ContractTermType": { "title": "ContractTermType", "description": "The type code is CTT", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "waterfallElement": { "type": "string", "maxLength": 255 }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "ContractTermTypeAttributeMeta": { "title": "ContractTermTypeAttributeMeta", "description": "The type code is CTTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ContractTree": { "title": "ContractTree", "description": "The type code is CTTREE", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ConfigurationWizard": { "title": "ConfigurationWizard", "description": "The type code is CW", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "executionFormula": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "wizardFormula": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "userGroup": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CX10": { "title": "CX10", "description": "The type code is CX10", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CX20": { "title": "CX20", "description": "The type code is CX20", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "CX3": { "title": "CX3", "description": "The type code is CX3", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute1": {}, "attribute3": {}, "attribute2": {}, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CX30": { "title": "CX30", "description": "The type code is CX30", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "CX50": { "title": "CX50", "description": "The type code is CX50", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" } } }, "CX6": { "title": "CX6", "description": "The type code is CX6", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CX8": { "title": "CX8", "description": "The type code is CX8", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "customerId": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CustomerExtensionAttributeMeta": { "title": "CustomerExtensionAttributeMeta", "description": "The type code is CXAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CustomFormType": { "description": "The Type code is CFOT.", "type": "object", "title": "CustomFormType", "properties": { "typedId": { "type": "string" }, "configuration": { "$ref": "#/components/schemas/configuration" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "module": { "type": "string", "maxLength": 255, "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS", "PROCESSES", "SALESCOMPENSATION", "CUSTOM_FORM" ], "description": "A name of application module, in which the user interface will show the menu item, which opens a page with a list of custom forms of this type. This is meaningful only when embedded is `false`.", "nullable": true }, "label": { "type": "string", "maxLength": 255, "description": "The name of the type, as displayed to the end users." }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255, "description": "A unique name of the type." }, "supportedParentTypeCodes": { "type": "array", "description": "List of entities, which are allowed to embed this custom form type (Quote, standalone Custom Form). This is meaningful only when embedded is `true`.", "nullable": true, "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "integer" }, "headerFormulaName": { "type": "string", "maxLength": 255, "description": "A name of the logic which implements the functionality of the Custom Form." }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "embedded": { "type": "boolean", "description": "If this custom form type can be embedded - i.e. used inside of another document, like quote." }, "workflowFormulaName": { "type": "string", "maxLength": 255, "description": "A name of the workflow logic, which will be used to build approval workflow for this Custom Form.", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "CustomForm": { "type": "object", "description": "The Type code is CFO.", "title": "CustomForm", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "integer", "nullable": true }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "nullable": true, "items": {} }, "alertMessage": { "type": "string", "nullable": true }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ], "nullable": true }, "displayOptions": { "type": "integer", "nullable": true }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string", "nullable": true }, "resultType": { "type": "string", "nullable": true }, "cssProperties": { "type": "string", "nullable": true }, "userGroup": { "type": "string", "nullable": true }, "resultGroup": { "type": "string", "nullable": true }, "overrideValueOptions": { "type": "array", "nullable": true, "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string", "nullable": true }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string", "nullable": true } } } }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string", "nullable": true }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string", "nullable": true }, "lookupTableId": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "type": { "type": "string" }, "value": { "type": "integer", "nullable": true }, "valueHint": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean", "nullable": true }, "filter": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true, "properties": { "property1": { "type": "object" }, "property2": { "type": "object" } } }, "parameterGroup": { "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "labelTranslations": { "type": "string", "nullable": true }, "addUnknownValues": { "type": "boolean", "nullable": true }, "typedId": { "type": "string", "nullable": true }, "alwaysEditable": { "type": "boolean", "nullable": true }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "properties": { "property1": { "type": "object", "nullable": true }, "property2": { "type": "object", "nullable": true } } }, "formattingOptions": { "type": "object", "properties": { "property1": { "type": "object", "nullable": true }, "property2": { "type": "object", "nullable": true } } }, "valueOptions": { "type": "array", "nullable": true, "items": { "type": "string" } } } } }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string" }, "serverMessagesExtended": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" }, "source": { "type": "string" } } } }, "customFormTypeObject": { "type": "object", "nullable": true, "properties": { "version": { "type": "integer" }, "typedId": { "type": "string", "nullable": true }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "headerFormulaName": { "type": "string" }, "workflowFormulaName": { "type": "string" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string" }, "embedded": { "type": "boolean" }, "supportedParentTypeCodes": { "type": "array", "items": { "type": "string" } }, "module": { "type": "string", "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS", "PROCESSES", "SALESCOMPENSATION", "CUSTOM_FORM", "ACTIONABLEINSIGHTS" ] }, "moduleCategoryUN": { "type": "string", "nullable": true }, "configuration": { "type": "object" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "deniedByName": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "maxLength": 255, "nullable": true }, "results": { "description": "any type" }, "originUniqueName": { "type": "string", "description": "The unique name of the origin CFO." }, "module": { "type": "string", "maxLength": 255, "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS", "PROCESSES", "SALESCOMPENSATION", "CUSTOM_FORM", "ACTIONABLEINSIGHTS" ] }, "originDeleted": { "type": "boolean", "description": "Indicates the deletion status of the origin CFO." }, "moduleCategoryUN": { "type": "string", "nullable": true }, "version": { "type": "integer" }, "originCustomFormId": { "type": "integer", "description": "Stores the identifier of the original CFO from which the current CFO was duplicated." }, "attribute9": { "description": "any type or null", "maxLength": 255 }, "attribute8": { "description": "any type or null", "maxLength": 255 }, "uniqueName": { "type": "string", "nullable": true, "maxLength": 255 }, "attribute5": { "description": "any type or `null`", "maxLength": 255 }, "attribute4": { "description": "any type or null", "maxLength": 255 }, "attribute7": { "description": "any type or null", "maxLength": 255 }, "attribute6": { "description": "any type or null", "maxLength": 255 }, "attribute1": { "description": "any type or null", "maxLength": 255 }, "attribute14": { "description": "any type or null", "maxLength": 255 }, "formStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "attribute13": { "description": "any type or null", "maxLength": 255 }, "typeId": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "description": "any type or null", "maxLength": 255 }, "attribute12": { "description": "any type or null", "maxLength": 255 }, "attribute2": { "description": "any type or null", "maxLength": 255 }, "attribute11": { "description": "any type or null", "maxLength": 255 }, "attribute10": { "description": "any type or null", "maxLength": 255 }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "renderInfo": { "type": "object", "nullable": true, "additionalProperties": { "type": "object", "nullable": true } }, "attribute19": { "description": "any type or null", "maxLength": 255 }, "attribute18": { "description": "any type or null", "maxLength": 255 }, "attribute17": { "description": "any type or null", "maxLength": 255 }, "attribute16": { "description": "any type or null", "maxLength": 255 }, "attribute15": { "description": "any type or null", "maxLength": 255 }, "submitDate": { "type": "string", "nullable": true }, "parentTypedId": { "type": "string", "maxLength": 255, "nullable": true }, "attribute25": { "description": "any type or null", "maxLength": 255 }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "attribute24": { "description": "any type or null", "maxLength": 255 }, "attribute23": { "description": "any type or null", "maxLength": 255 }, "attribute22": { "description": "any type or null", "maxLength": 255 }, "attribute21": { "description": "any type or null", "maxLength": 255 }, "attribute20": { "description": "any type or null", "maxLength": 255 }, "createDate": { "type": "string", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "object", "nullable": true } }, "attribute29": { "description": "any type or null", "maxLength": 255 }, "attribute28": { "description": "any type or null", "maxLength": 255 }, "originLabel": { "type": "string" }, "attribute27": { "description": "any type or null", "maxLength": 255 }, "attribute26": { "description": "any type or null", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "integer" }, "prevRev": { "type": "string", "nullable": true }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string", "nullable": true }, "attribute30": { "description": "any type or null", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "DataArchive": { "title": "DataArchive", "description": "The type code is DA", "type": "object", "properties": { "cluster": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "archiveName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "archiveType": { "type": "string", "enum": [ "ARCHIVE", "CLEANUP" ] }, "createdBy": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "Dashboard": { "title": "Dashboard", "description": "The type code is DB", "type": "object", "properties": { "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "typedId": { "type": "string" }, "configuration": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "relativeTargetDateDays": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "hide": { "type": "boolean" }, "dynamicInputs": { "type": "boolean" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "category": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequest": { "title": "DataChangeRequest", "description": "The type code is DCR.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "nullable": true, "items": { "type": "string", "nullable": true } }, "dcrTypeName": { "type": "string", "maxLength": 255 }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ], "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "deniedByName": { "type": "string", "nullable": true }, "dcrTargetType": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "dcrTargetInfo": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequestItemAM": { "title": "DataChangeRequestItemAM", "description": "The type code is DCRAM", "type": "object", "properties": { "changeRequestId": { "type": "integer" }, "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequestItem": { "title": "DataChangeRequestItem", "description": "The type code is DCRI.", "type": "object", "properties": { "key1": { "type": "string", "maxLength": 255, "nullable": true }, "changeRequestId": { "type": "integer" }, "key2": { "type": "string", "maxLength": 255, "nullable": true }, "typedId": { "type": "string" }, "key5": { "type": "string", "maxLength": 100, "nullable": true }, "key6": { "type": "string", "maxLength": 100, "nullable": true }, "key3": { "type": "string", "maxLength": 255, "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "key4": { "type": "string", "maxLength": 150, "nullable": true }, "approvalReason": { "type": "string", "maxLength": 255, "nullable": true }, "sku": { "type": "string", "maxLength": 255 }, "unitOfMeasure": { "type": "string", "maxLength": 255, "nullable": true }, "version": { "type": "integer" }, "attribute9": {}, "deleteRow": { "type": "boolean" }, "attribute8": {}, "attribute5": {}, "attribute4": {}, "attribute7": {}, "attribute6": {}, "name": { "type": "string", "maxLength": 255, "nullable": true }, "attribute1": {}, "attribute14": {}, "attribute13": {}, "attribute3": {}, "attribute12": {}, "attribute2": {}, "attribute11": {}, "attribute10": {}, "attribute19": {}, "attribute18": {}, "attribute17": {}, "itemTypedId": {}, "attribute16": {}, "attribute15": {}, "oldValues": { "type": "object", "additionalProperties": { "type": "object", "properties": { "oldValue": { "type": "string" }, "newValue": { "type": "string" } } }, "nullable": true }, "ignoreChange": { "type": "boolean" }, "customerId": { "type": "string", "maxLength": 255, "nullable": true }, "attribute25": {}, "attribute24": {}, "currency": { "type": "string", "maxLength": 255, "nullable": true }, "attribute23": {}, "attribute22": {}, "attribute21": {}, "value": { "type": "string", "maxLength": 255, "nullable": true }, "attribute20": {}, "createDate": { "type": "string", "format": "date-time" }, "comments": { "type": "string", "maxLength": 255, "nullable": true }, "attribute29": {}, "attribute28": {}, "attribute27": {}, "attribute26": {}, "label": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "changeRef": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true }, "attribute30": {}, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequestLog": { "title": "DataChangeRequestLog", "description": "The type code is DCRL", "type": "object", "properties": { "logType": { "type": "string", "maxLength": 255 }, "maxId": { "type": "integer" }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "count": { "type": "integer" }, "minId": { "type": "integer" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequestMassChange": { "title": "DataChangeRequestMassChange", "description": "The type code is DCRMC.", "type": "object", "properties": { "typedId": { "type": "string" }, "comments": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer" }, "massChange": { "type": "object", "nullable": true, "properties": { "definitions": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "massEditOperator": { "type": "string", "enum": [ "=", "+", "-", "*" ] }, "itemAction": { "type": "string", "enum": [ "edit", "recalculate" ] }, "changeStateReason": { "type": "string", "nullable": true }, "precision": { "type": "integer", "nullable": true } } } }, "filter": { "type": "object" }, "type": { "type": "string", "enum": [ "EDIT", "DELETE" ], "nullable": true } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataChangeRequestType": { "title": "DataChangeRequestType", "description": "The type code is DCRT", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "targetObjectTypeCode": { "type": "string", "maxLength": 255 }, "targetObjectTypedId": { "type": "string", "maxLength": 255 }, "targetObjectName": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DataExport": { "title": "DataExport", "description": "The type code is DE", "type": "object", "properties": { "cluster": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "archiveName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "DataImport": { "title": "DataImport", "description": "The type code is DI", "type": "object", "properties": { "cluster": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "archiveName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "sourceArchive": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "keepUnknownMetaLinks": { "type": "boolean" }, "createdBy": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "DMDatamart": { "title": "DMDatamart", "description": "The type code is DM", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "reservedWords": { "type": "array", "items": { "type": "string" } }, "lastUpdateByName": { "type": "string" }, "typedId": { "type": "string" }, "keyFieldNames": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "dbTable": { "type": "string" }, "deployed": { "type": "boolean" }, "source": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "enum": [ "DATASOURCE", "DS_VIEW", "DATAMART", "SIM_DATAMART", "FEED", "DW_TABLE", "MODEL", "VIEW", "ROLLUP" ] }, "calculationDate": { "type": "string" }, "sourceFile": { "type": "string", "maxLength": 255 }, "valid": { "type": "boolean" }, "view": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "type": "string" } }, "keyFields": { "type": "array", "items": { "type": "object" } }, "auxiliary": { "type": "boolean" }, "normalization": { "type": "string", "maxLength": 255, "enum": [ "NONE", "LOW", "MEDIUM", "HIGH", "VIEW" ] }, "rowCount": { "type": "integer" }, "locked": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastDataModificationDate": { "type": "string", "format": "date-time" }, "calculationMessages": { "type": "string" }, "localFields": { "type": "array", "items": { "type": "string" } }, "targetDate": { "type": "string", "format": "date-time" }, "query": { "type": "object", "additionalProperties": { "type": "string" } }, "isPlasma": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "dbKey": { "type": "string" }, "queryable": { "type": "boolean" }, "dbView": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "baseCcyCode": { "type": "string" }, "sourceName": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "system": { "type": "boolean" }, "deleted": { "type": "boolean" }, "calculated": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "deployed": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "dbColumn": { "type": "string" }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "source": { "type": "string" }, "owningFC": { "type": "string" } } } }, "calculationStartDate": { "type": "string" }, "baseUomCode": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateBy": { "type": "integer" } } }, "DMDataChunk": { "title": "DMDataChunk", "description": "The type code is DMDC", "type": "object", "properties": { "clientResourceId": { "type": "string", "maxLength": 255 }, "chunkNumber": { "type": "integer" }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "numberOfRecords": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "digest": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "CREATED", "SUCCESS", "FAILED" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DMDataLoad": { "title": "DMDataLoad", "description": "The type code is DMDL.", "type": "object", "properties": { "adhocDataLoadDefinition": { "type": "object", "nullable": true }, "targetName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "allowBatching": { "type": "boolean", "nullable": true }, "locale": { "type": "string", "maxLength": 255, "nullable": true }, "type": { "type": "string", "maxLength": 255, "enum": [ "DM_REFRESH", "DS_FLUSH", "DS_PRODUCTS", "DS_CUSTOMERS", "DS_DEFAULTCAL", "CALCULATION", "TRUNCATE", "DM_SIMULATION", "DMM_CALCULATION", "MR_CALCULATION", "DS_INTERNAL_COPY", "INDEX_MAINTENANCE", "ADD_TABLE_PARTITIONS", "DISTRIBUTED_CALCULATION", "IMPORT" ] }, "calculationDate": { "type": "string", "format": "date-time", "nullable": true }, "jstId": { "type": "integer", "nullable": true }, "sourceSortBy": { "type": "string", "maxLength": 255, "nullable": true }, "withTargetSnapshot": { "type": "boolean" }, "actionUUID": { "type": "string", "maxLength": 255, "nullable": true }, "valid": { "type": "boolean" }, "loadCompleteTime": { "type": "integer", "nullable": true }, "incLoadDate": { "type": "string", "format": "date-time", "nullable": true }, "loadMode": { "type": "string", "enum": [ "FULL", "INCREMENTAL", "ENRICHMENT", "ALLOCATION", null ], "nullable": true }, "schedules": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "name": { "type": "string" }, "calculableTypedId": { "type": "string" }, "calculableLabel": { "type": "string" }, "period": { "type": "string", "enum": [ "MINUTE", "HOUR", "DAY" ] }, "interval": { "type": "integer" }, "lastRunDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "startDate": { "type": "string" } } } }, "continuous": { "type": "boolean" }, "sortBy": { "type": "string", "maxLength": 255, "nullable": true }, "dtoSourceFilter": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "calculationContext": { "type": "string", "maxLength": 255, "nullable": true }, "calculationResults": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } } }, "testRow": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "resultTableUniqueName": { "type": "string", "nullable": true }, "pre80CalculationConfig": { "type": "object", "nullable": true, "properties": { "skuField": { "type": "string" }, "targetDateField": { "type": "string" }, "simulationSet": { "type": "string" }, "formulaName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time", "nullable": true }, "feederFormulaName": { "type": "string" }, "feederInputParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "formulaName": { "type": "string" }, "formulaDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "key": { "type": "boolean" }, "selected": { "type": "boolean" }, "displayedInPriceShop": { "type": "boolean" } } } }, "targetFields": { "type": "array", "items": { "type": "string" } } } }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time", "nullable": true }, "validationLogic": { "type": "string", "maxLength": 255, "nullable": true }, "isPlasma": { "type": "boolean" }, "distributed": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "incremental": { "type": "boolean" }, "version": { "type": "integer" }, "requestTime": { "type": "integer" }, "dtoFilter": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "isDefault": { "type": "boolean" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "calcItemsLookupTableId": { "type": "integer" }, "sourceName": { "type": "string", "maxLength": 255, "nullable": true }, "progressInfo": { "type": "object", "additionalProperties": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "WAITING_FOR_DISPATCH", "QUEUED_FOR_EXECUTION", "PROCESSING", "FAILED", "FINISHED", "CANCELLED", "INTERRUPTED" ] }, "name": { "type": "string" }, "progress": { "type": "string" }, "errors": { "type": "integer" }, "running": { "type": "boolean" }, "pending": { "type": "boolean" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "nullable": true }, "testResult": { "type": "object", "nullable": true, "properties": { "initResult": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "rowResult": { "type": "array", "items": { "type": "object" } }, "summaryResult": { "type": "array", "items": { "type": "object" } }, "inputRow": { "type": "object", "additionalProperties": { "type": "string" } }, "outputRow": { "type": "object", "additionalProperties": { "type": "string" } }, "alerts": { "type": "object", "additionalProperties": { "type": "string" } } } }, "calculationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "calculationConfig": { "type": "object" }, "lastUpdateTime": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "DMDataSource": { "title": "DMDataSource", "description": "The type code is DMDS", "type": "object", "properties": { "reservedWords": { "type": "array", "items": { "type": "string" } }, "sourceId": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "keyFieldNames": { "type": "array", "items": { "type": "string" } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "persistedObjectClass": { "type": "string", "maxLength": 255 }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "dbTable": { "type": "string" }, "identikitFilter": { "type": "string" }, "type": { "type": "string", "enum": [ "DATASOURCE", "DS_VIEW", "DATAMART", "SIM_DATAMART", "FEED", "DW_TABLE", "MODEL", "VIEW", "ROLLUP" ] }, "sourceFile": { "type": "string", "maxLength": 255 }, "identikitCriteria": { "type": "object", "additionalProperties": { "type": "string" } }, "integrateVerb": { "type": "string" }, "view": { "type": "boolean" }, "locked": { "type": "boolean" }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "warningsOn": { "type": "boolean" }, "query": { "type": "object", "additionalProperties": { "type": "string" } }, "bulkloadVerb": { "type": "string" }, "version": { "type": "integer" }, "dbKey": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "system": { "type": "boolean" }, "deleted": { "type": "boolean" }, "calculated": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "deployed": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "dbColumn": { "type": "string" }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "source": { "type": "string" }, "owningFC": { "type": "string" } } } }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "formulaName": { "type": "string", "maxLength": 255 }, "lastUpdateByName": { "type": "string" }, "sourceLabel": { "type": "string", "maxLength": 255 }, "fetchVerb": { "type": "string" }, "deployed": { "type": "boolean" }, "calculationDate": { "type": "string" }, "valid": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "type": "string" } }, "keyFields": { "type": "array", "items": { "type": "object" } }, "auxiliary": { "type": "boolean" }, "rowCount": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastDataModificationDate": { "type": "string", "format": "date-time" }, "sourceTypeCode": { "type": "string", "maxLength": 255 }, "isPlasma": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "truncateVerb": { "type": "string" }, "typeCode": { "type": "string" }, "queryable": { "type": "boolean" }, "dbView": { "type": "string" }, "createdBy": { "type": "integer" }, "sourceName": { "type": "string" }, "calculationStartDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "DMDataFeed": { "title": "DMDataFeed", "description": "The type code is DMF", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "reservedWords": { "type": "array", "items": { "type": "string" } }, "lastUpdateByName": { "type": "string" }, "typedId": { "type": "string" }, "keyFieldNames": { "type": "array", "items": { "type": "string" } }, "fetchVerb": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "dbTable": { "type": "string" }, "deployed": { "type": "boolean" }, "type": { "type": "string", "enum": [ "DATASOURCE", "DS_VIEW", "DATAMART", "SIM_DATAMART", "FEED", "DW_TABLE", "MODEL", "VIEW", "ROLLUP" ] }, "calculationDate": { "type": "string" }, "sourceFile": { "type": "string", "maxLength": 255 }, "identikitCriteria": { "type": "object", "additionalProperties": { "type": "string" } }, "valid": { "type": "boolean" }, "defaultDataSourceName": { "type": "string", "maxLength": 255 }, "integrateVerb": { "type": "string" }, "view": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "type": "string" } }, "keyFields": { "type": "array", "items": { "type": "object" } }, "auxiliary": { "type": "boolean" }, "draft": { "type": "boolean" }, "rowCount": { "type": "integer" }, "locked": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastDataModificationDate": { "type": "string", "format": "date-time" }, "quoteChar": { "type": "string", "maxLength": 255 }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "query": { "type": "object", "additionalProperties": { "type": "string" } }, "isPlasma": { "type": "boolean" }, "bulkloadVerb": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "fieldSeperator": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "dbKey": { "type": "string" }, "typeCode": { "type": "string" }, "queryable": { "type": "boolean" }, "dbView": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "sourceName": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "system": { "type": "boolean" }, "deleted": { "type": "boolean" }, "calculated": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "deployed": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "dbColumn": { "type": "string" }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "source": { "type": "string" }, "owningFC": { "type": "string" } } } }, "lineSeperator": { "type": "string", "maxLength": 255 }, "calculationStartDate": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateBy": { "type": "integer" } } }, "DMModel": { "title": "DMModel", "description": "The type code is DMM", "type": "object", "properties": { "reservedWords": { "type": "array", "items": { "type": "string" } }, "isDataModel": { "type": "boolean" }, "typedId": { "type": "string" }, "keyFieldNames": { "type": "array", "items": { "type": "string" } }, "inputs": { "type": "object", "additionalProperties": { "type": "string" } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "DATASOURCE", "DS_VIEW", "DATAMART", "SIM_DATAMART", "FEED", "DW_TABLE", "MODEL", "VIEW", "ROLLUP" ] }, "sourceFile": { "type": "string", "maxLength": 255 }, "paramsLookupTableName": { "type": "string" }, "view": { "type": "boolean" }, "calcItemsLookupTableName": { "type": "string" }, "legacyParamsLookupTableName": { "type": "string" }, "legacyCalcItemsLookupTableName": { "type": "string" }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "locked": { "type": "boolean" }, "calculationResults": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } } }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "modelNatureUN": { "type": "string" }, "query": { "type": "object", "additionalProperties": { "type": "string" } }, "modelType": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "modelNature": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "modelTypeDefJson": { "type": "string" } } }, "modelTypeDef": { "type": "object", "properties": { "logic": { "type": "string" }, "libLogic": { "type": "string" }, "analysisLogic": { "type": "string" }, "evalLogic": { "type": "string" }, "recordLogic": { "type": "string" }, "generatesData": { "type": "boolean" }, "generatesTables": { "type": "boolean" }, "generatesRecords": { "type": "boolean" }, "generatesTrees": { "type": "boolean" }, "calcSteps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "category": { "type": "string" }, "logic": { "type": "string" }, "distributed": { "type": "boolean" } } } } } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "modelNatureUN": { "type": "string" }, "modelTypeDefJson": { "type": "string" } } }, "version": { "type": "integer" }, "dbKey": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "numberOfItems": { "type": "integer" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "calcItemsLookupTableId": { "type": "integer" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "system": { "type": "boolean" }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "deleted": { "type": "boolean" }, "calculated": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "deployed": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "dbColumn": { "type": "string" }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "source": { "type": "string" }, "owningFC": { "type": "string" } } } }, "calculationConfig": { "type": "object", "properties": { "skuField": { "type": "string" }, "targetDateField": { "type": "string" }, "simulationSet": { "type": "string" }, "formulaName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "feederFormulaName": { "type": "string" }, "feederInputParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "formulaName": { "type": "string" }, "formulaDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "key": { "type": "boolean" }, "selected": { "type": "boolean" }, "displayedInPriceShop": { "type": "boolean" } } } }, "targetFields": { "type": "array", "items": { "type": "string" } } } }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "formulaName": { "type": "string", "maxLength": 255 }, "lastUpdateByName": { "type": "string" }, "modelTypeUN": { "type": "string", "maxLength": 255 }, "parentUniqueName": { "type": "string", "maxLength": 255 }, "deployed": { "type": "boolean" }, "hasRowLevelAnalysis": { "type": "boolean" }, "paramsLookupTableId": { "type": "integer" }, "calculationDate": { "type": "string" }, "dataModelSourceName": { "type": "string", "maxLength": 255 }, "valid": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "type": "string" } }, "isQueryDefined": { "type": "boolean" }, "rootModelSourceName": { "type": "string", "maxLength": 255 }, "keyFields": { "type": "array", "items": { "type": "object" } }, "auxiliary": { "type": "boolean" }, "parentTypedId": { "type": "string", "maxLength": 255 }, "itemListFilterField": { "type": "string" }, "rowCount": { "type": "integer" }, "itemAttributeMetaClass": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastDataModificationDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "isSimpleModel": { "type": "boolean" }, "queryable": { "type": "boolean" }, "dbView": { "type": "string" }, "createdBy": { "type": "integer" }, "itemClass": { "type": "string" }, "sourceName": { "type": "string" }, "calculationStartDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "DMRollup": { "title": "DMRollup", "description": "The type code is DMR", "type": "object", "properties": { "owner": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "queryDto": { "type": "object", "additionalProperties": { "type": "string" } }, "typedId": { "type": "string" }, "visibility": { "type": "string", "maxLength": 255, "enum": [ "PRIVATE", "PUBLISHED", "PUBLIC" ] }, "ownerAndLabel": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "materialized": { "type": "boolean" }, "isPlasma": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "draft": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DMTable": { "title": "DMTable", "description": "The type code is DMT", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "reservedWords": { "type": "array", "items": { "type": "string" } }, "lastUpdateByName": { "type": "string" }, "typedId": { "type": "string" }, "keyFieldNames": { "type": "array", "items": { "type": "string" } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldNames": { "type": "array", "items": { "type": "string" } }, "dbTable": { "type": "string" }, "deployed": { "type": "boolean" }, "type": { "type": "string", "enum": [ "DATASOURCE", "DS_VIEW", "DATAMART", "SIM_DATAMART", "FEED", "DW_TABLE", "MODEL", "VIEW", "ROLLUP" ] }, "calculationDate": { "type": "string" }, "sourceFile": { "type": "string", "maxLength": 255 }, "valid": { "type": "boolean" }, "view": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "type": "string" } }, "keyFields": { "type": "array", "items": { "type": "object" } }, "auxiliary": { "type": "boolean" }, "rowCount": { "type": "integer" }, "locked": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastDataModificationDate": { "type": "string", "format": "date-time" }, "owner": { "type": "string", "maxLength": 255 }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "query": { "type": "object", "additionalProperties": { "type": "string" } }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "dbKey": { "type": "string" }, "queryable": { "type": "boolean" }, "dbView": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "sourceName": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "object", "additionalProperties": { "type": "string" } }, "rank": { "type": "integer" }, "format": { "type": "string" }, "measureType": { "type": "string", "enum": [ "PERUNIT", "EXTENDED", "FIXED" ] }, "functionalType": { "type": "string", "enum": [ "PERUNITBASIS", "PERCENTBASIS", "PRICINGDATE", "LEVEL", "ALTKEY", "OBSOLETE_CONVERSIONFROM", "OBSOLETE_CONVERSIONTO", "OBSOLETE_CONVERSIONRATE", "OBSOLETE_BASECCY", "OBSOLETE_BASEUOM", "TIMEDIMENSION", "OBSOLETE_DELETE" ] }, "visibility": { "type": "integer" }, "defaultValue": { "type": "string" }, "sourceField": { "type": "string" }, "expression": { "type": "string" }, "function": { "type": "string", "enum": [ "SUM", "AVG", "MIN", "MAX", "COUNT", "EVERY", "ANY", "COUNTDISTINCT", "COUNT_DISTINCT", "PERCENTILE_DISC", "PERCENTILE_CONT", "ROW_NUMBER", "ROW_ID", "PERCENT_RANK", "CUME_DIST", "NTILE", "BIN_IDX", "BIN_ABS", "BIN_PCT", "ISNULL", "IF", "IFNULL", "NULLIF", "TOSTRING", "TODATE", "SQL0", "SQL1", "SQL2", "SQL3", "SQL4", "SQL5", "PARSE", "RANGE", "CEILING", "FLOOR", "ROUND", "CORR", "COVAR_POP", "COVAR_SAMP", "REGR_AVGX", "REGR_AVGY", "REGR_COUNT", "REGR_INTERCEPT", "REGR_R2", "REGR_SLOPE", "REGR_SXX", "REGR_SXY", "REGR_SYY", "STDDEV_POP", "STDDEV_SAMP", "VAR_POP", "VAR_SAMP" ] }, "formulaElement": { "type": "string" }, "messages": { "type": "object", "additionalProperties": { "type": "string" } }, "system": { "type": "boolean" }, "numeric": { "type": "boolean" }, "key": { "type": "boolean" }, "deleted": { "type": "boolean" }, "calculated": { "type": "boolean" }, "persisted": { "type": "boolean" }, "dimension": { "type": "boolean" }, "deployed": { "type": "boolean" }, "queryable": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "partitioningKey": { "type": "boolean" }, "time": { "type": "boolean" }, "aggregation": { "type": "boolean" }, "dbColumn": { "type": "string" }, "dbTable": { "type": "string" }, "type": { "type": "string", "enum": [ "NUMBER", "QUANTITY", "TEXT", "DATE", "MONEY", "CURRENCY", "UOM", "LOB", "DATETIME", "BOOLEAN", "INTEGER" ] }, "source": { "type": "string" }, "owningFC": { "type": "string" } } } }, "calculationStartDate": { "type": "string" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateBy": { "type": "integer" } } }, "DocumentRef": { "title": "DocumentRef", "description": "The type code is DREF", "type": "object", "properties": { "typedId": { "type": "string" }, "documentType": { "type": "string", "maxLength": 255, "enum": [ "QUOTE", "CONTRACT", "REBATE_AGREEMENT", "CLAIM", "PRICE_LIST", "COMPENSATION", "CUSTOM_FORM", "QUOTETMP", "CONTRACTTMP", "REBATE_AGREEMENTTMP", "COMPENSATIONTMP", "MODEL_OBJECT", "MANUAL_PRICE_LIST", "SIMULATION", "PRICE_GRID" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "lineId": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "objectType": { "type": "string", "maxLength": 255, "enum": [ "CUSTOM_FORM", "QUOTE", "CONTRACT", "REBATE_AGREEMENT", "COMPENSATION", "ACTIONITEM", "QUOTETMP", "CONTRACTTMP", "REBATE_AGREEMENTTMP", "COMPENSATIONTMP" ] }, "createdBy": { "type": "integer" }, "final": { "type": "boolean" }, "documentId": { "type": "integer" }, "docTypedId": { "type": "string", "maxLength": 255 }, "objectId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "DeviceRegistration": { "title": "DeviceRegistration", "description": "The type code is DREG", "type": "object", "properties": { "typedId": { "type": "string" }, "deviceFingerprint": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "encryptionKey": { "type": "string", "maxLength": 255 }, "failedUnlockAttempts": { "type": "integer" }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "unlockToken": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "EntityDeploymentLog": { "title": "EntityDeploymentLog", "description": "The type code is EDL", "type": "object", "properties": { "targetUpdated": { "type": "boolean" }, "targetName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "targetDeleted": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "sourceTransactionId": { "type": "string", "maxLength": 255 }, "targetTypedId": { "type": "string", "maxLength": 255 }, "targetVersion": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "EmailTask": { "title": "EmailTask", "description": "The type code is ET", "type": "object", "properties": { "typedId": { "type": "string" }, "subject": { "type": "string", "maxLength": 2048 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string", "maxLength": 255 }, "sourceObject": { "type": "string", "maxLength": 255 }, "body": { "type": "string" }, "version": { "type": "integer" }, "sent": { "type": "boolean" }, "retriesLeft": { "type": "integer" }, "attachment": { "type": "boolean" }, "createdBy": { "type": "integer" }, "sender": { "type": "object", "properties": { "senderName": { "type": "string" }, "senderEmailAddress": { "type": "string" } } }, "replyTo": { "type": "object", "properties": { "replyToName": { "type": "string" }, "replyToEmailAddress": { "type": "string" } } }, "recipient": { "type": "string" }, "plainText": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "EventTask": { "title": "EventTask", "description": "The type code is EVT", "type": "object", "properties": { "typedId": { "type": "string" }, "retriesLeft": { "type": "integer" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "httpResponse": { "type": "integer" }, "message": { "type": "string" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PricingFormula": { "title": "Formula", "description": "The `Formula` object. The type code is F.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string" }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "formulaNature": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "simulationSet": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "formulaType": { "type": "string", "enum": [ "PRICING", "WORKFLOW", "LIBRARY" ] }, "createdBy": { "type": "integer" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "elementDescription": { "type": "string" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "conditionElementName": { "type": "string" }, "hideWarnings": { "type": "boolean" }, "excludeFromExport": { "type": "boolean" }, "protectedExpression": { "type": "boolean" }, "elementTimeout": { "type": "integer" }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "elementSuffix": { "type": "string" }, "allowOverride": { "type": "boolean" }, "summarize": { "type": "boolean" }, "hideOnNull": { "type": "boolean" }, "userGroup": { "type": "string" }, "cssProperties": { "type": "string" }, "resultGroup": { "type": "string" }, "combinationType": { "type": "string", "enum": [ "ADD", "SUBTRACT", "RESULT", "INFO", "FUNCTION", "BRICK", "PYTHON" ] }, "criticalAlert": { "type": "object", "properties": { "message": { "type": "string" }, "operator": { "type": "string" }, "threshold": { "type": "number" }, "comparisonElement": { "type": "string" } } }, "redAlert": { "type": "object" }, "yellowAlert": { "type": "object" }, "labelTranslations": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "formulaExpression": { "type": "string" } } } }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "validAfter": { "type": "string", "format": "date" }, "inputDescriptors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "labelTranslations": { "type": "string" }, "group": { "type": "string" }, "dataType": { "type": "string" }, "inputType": { "type": "string" }, "formatType": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" }, "values": { "type": "string" }, "required": { "type": "boolean" }, "alwaysEditable": { "type": "boolean" } } } }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "SIMULATIONONLY", "INACTIVE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PricingFormulaElement": { "title": "PricingFormulaElement", "description": "The type code is FE", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "formulaExpression": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "protectedExpression": { "type": "boolean" }, "hideWarnings": { "type": "boolean" }, "elementTimeout": { "type": "integer" }, "resultGroup": { "type": "string", "maxLength": 255 }, "redAlert": { "type": "object" }, "elementName": { "type": "string", "maxLength": 255 }, "yellowAlert": { "type": "object" }, "elementSuffix": { "type": "string", "maxLength": 255 }, "elementLabel": { "type": "string", "maxLength": 255 }, "combinationType": { "type": "string", "maxLength": 255, "enum": [ "ADD", "SUBTRACT", "RESULT", "INFO", "FUNCTION", "BRICK", "PYTHON" ] }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "hideOnNull": { "type": "boolean" }, "userGroup": { "type": "string", "maxLength": 255 }, "allowOverride": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "conditionElementName": { "type": "string", "maxLength": 255 }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "version": { "type": "integer" }, "criticalAlert": { "type": "object", "properties": { "message": { "type": "string" }, "operator": { "type": "string" }, "threshold": { "type": "number" }, "comparisonElement": { "type": "string" } } }, "excludeFromExport": { "type": "boolean" }, "displayOptions": { "type": "integer" }, "createdBy": { "type": "integer" }, "summarize": { "type": "boolean" }, "elementDescription": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "FilterNode": { "title": "FilterNode", "description": "The type code is FN", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "numberOfChildNodes": { "type": "integer" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "parentId": { "type": "integer" }, "output": { "type": "string", "maxLength": 255 }, "dtoFilter": { "type": "object", "additionalProperties": { "type": "string" } }, "depth": { "type": "integer" }, "treeName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "ownerTypedId": { "type": "string", "maxLength": 255 }, "filterDescription": { "type": "string", "maxLength": 255 }, "id": { "type": "integer" }, "isOther": { "type": "boolean" }, "ordinal": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "HookEvent": { "title": "HookEvent", "description": "The type code is HEVT", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "eventAllowedToContinue": { "type": "boolean" }, "errorMessage": { "type": "string", "maxLength": 255 }, "eventType": { "type": "string", "maxLength": 255, "enum": [ "QUOTE_TO_DEAL_PRE" ] }, "version": { "type": "integer" }, "executionTime": { "type": "integer" }, "executedByUsername": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "objectName": { "type": "string", "maxLength": 255 }, "executedSuccessfully": { "type": "boolean" }, "objectId": { "type": "integer" }, "objectLabel": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "HeaderRebateType": { "title": "HeaderRebateType", "description": "The type code is HRT", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "headerFormulaName": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "defaultTypeDeleteNotAllowedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "rebateTypeFilterFormulaName": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "editNotAllowedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "workflowFormulaName": { "type": "string", "maxLength": 255 }, "recordWorkflowFormulaName": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "HeaderRebateTypeAttributeMeta": { "title": "HeaderRebateTypeAttributeMeta", "description": "The type code is HRTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ImportManager": { "title": "ImportManager", "type": "object", "description": "The type code is IM.", "properties": { "lastUpdateByName": { "type": "string" }, "createdByName": { "type": "string" }, "targetObject": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time", "nullable": true }, "approvalRequiredEmailAttachments": { "type": "array", "items": {} }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "targetSpecifics": { "type": "string", "maxLength": 255, "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "ownerUN": { "type": "string", "maxLength": 255 }, "deniedByName": { "type": "string", "nullable": true }, "importOptions": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true, "properties": { "includeNewRows": { "type": "boolean", "nullable": true }, "includeDeletedRows": { "type": "boolean", "nullable": true }, "includeUpdatedRows": { "type": "boolean", "nullable": true } } }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "workflowFormulaName": { "type": "string", "maxLength": 255, "nullable": true }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "IN_PROGRESS", "CHANGE_DETECTION", "FINISHED", "ERROR" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ImportChange": { "title": "ImportChange", "type": "object", "description": "The type code is IMC.", "properties": { "typedId": { "type": "string" }, "managerUN": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "originalValue": { "type": "string", "maxLength": 255, "nullable": true }, "databaseValue": { "type": "string", "nullable": true }, "targetPrimaryKeys": { "type": "object" }, "typeOfChange": { "type": "string", "maxLength": 255, "enum": [ "CREATE", "UPDATE", "DELETE" ] }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "validationErrors": { "type": "array", "nullable": true, "items": {} }, "value": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "columnName": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "InlineDetailsConfiguration": { "title": "InlineDetailsConfiguration", "description": "The type code is IDC", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "targetObjectTypeCode": { "type": "string", "maxLength": 255 }, "targetObjectTypedId": { "type": "string", "maxLength": 255 }, "targetObjectName": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "InternalEvent": { "title": "InternalEvent", "description": "The type code is IE", "type": "object", "properties": { "customEventType": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "trackerId": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string", "nullable": true } }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "eventType": { "type": "string", "maxLength": 255, "enum": [ "CALCULATION_COMPLETED_PL", "CALCULATION_COMPLETED_SIM", "CALCULATION_COMPLETED_CFS", "CALCULATION_COMPLETED_PG", "CALCULATION_COMPLETED_RC", "ITEM_APPROVED_CT", "ITEM_APPROVED_PGI", "ITEM_APPROVED_PL", "ITEM_APPROVED_Q", "ITEM_APPROVED_RR", "ITEM_APPROVED_DCR", "ITEM_UPDATE_RR", "ITEM_UPDATE_PR", "ITEM_UPDATE_PGI", "ITEM_UPDATE_MPLI", "CHANGE_NOTIFICATION_CA", "CHANGE_NOTIFICATION_MPL", "WORKFLOW_MESSAGE", "PADATALOAD_COMPLETED", "CUSTOM", "ITEM_UPDATE_PPV", "CHANGE_NOTIFICATION_PP", "WORKFLOW_SUBMIT", "ITEM_DENIED_PGI", "ITEM_UPDATE_Q", "ITEM_UPDATE_CT", "ITEM_APPROVED_RBA", "ITEM_APPROVED_CL", "ITEM_UPDATE_CL", "JOB_FAILED", "ACTION_STATUS" ] }, "version": { "type": "integer" }, "operation": { "type": "string", "maxLength": 255, "enum": [ "UPDATE", "DELETE", "ADD", "ITEMCHANGE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "IntegrationStatusHistory": { "title": "IntegrationStatusHistory", "description": "The type code is ISH", "type": "object", "properties": { "intgStatusDetails": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "itemTypedId": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "intgStatus": { "type": "string", "maxLength": 255 }, "intgStatusErpReference": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "JsonConfigurationStorage": { "title": "JsonConfigurationStorage", "type": "object", "description": "The type code is JCS. Stores configuration for **Strategy Designer** and **Formula Designer**.", "properties": { "lastUpdateByName": { "type": "string" }, "createdByName": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "storageStatus": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "SUPERSEDED" ] }, "label": { "type": "string", "maxLength": 255, "nullable": true }, "version": { "type": "integer" }, "jsonStorage": { "type": "string", "description": "A valid json of any size." }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "storageType": { "type": "string", "enum": [ "STRATEGY", "STRATEGY_LOOKUP", "FORMULA", "FORMULA_LOOKUP" ] }, "id": { "type": "integer" }, "supersededBy": { "type": "integer", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "JsonLookupTableValue": { "title": "JsonLookupTableValue", "description": "The type code is JLTV", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "JsonLookupTableValue2Key": { "title": "JsonLookupTableValue2Key", "description": "The type code is JLTV2", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "key1": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "tableId": { "type": "integer" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "JsonLookupTableAttributeMeta": { "title": "JsonLookupTableAttributeMeta", "description": "The type code is JLTVM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "lookupTableId": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "JobStatusTracker": { "title": "JobStatusTracker", "description": "The type code is JST.", "type": "object", "properties": { "processingStart": { "type": "string", "nullable": true }, "targetObject": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "trackerType": { "type": "string", "maxLength": 255, "enum": [ "PRICELIST", "PRICELIST_DIRTY", "SIMULATION", "SIMULATION_DIRTY", "PRICEGRID", "PRICEGRID_DIRTY", "CFS", "REBATERECORD", "PRICEAPI_OBSOLETE", "MASSUPDATE", "IFP_OBSOLETE", "DATAEXPORT", "DATAIMPORT", "OBJREF", "PADATALOAD", "CALCULATIONFLOW", "PRICELIST_MERGE", "DATAARCHIVE", "RAT_CALC", "MOVE_OX", "DELETE_DATA", "DB_MIGRATION", "SERVER_MIGRATION", "DATACLEANUP", "QUOTES_MASS_UPDATE", "CONTRACTS_MASS_UPDATE", "CLAIM", "CLAIM_SUBMIT", "SIGNATURE", "PRODUCT_IMAGES_DELETE", "JOB_TRIGGER_CALCULATION", "QUOTE", "CLIC_MASS_EDIT", "MASS_ACTION", "CONTRACT", "REBATE_AGREEMENT", "RRG_SUBMIT", "MODEL_CALCULATION", "MODEL_PARALLEL_CALCULATION", "MODEL_CALCULATION_SEQUENCE", "COMPENSATION", "COMPENSATION_AGREEMENT", "COMPENSATION_RECORD", "CALCULATIONGRID", "CONDITION_RECORD", "DCR_SUBMIT" ] }, "threadId": { "type": "integer", "nullable": true }, "jobSettings": { "type": "object", "properties": { "distributedAction": { "type": "object", "nullable": true, "properties": { "calculableObjectTypedId": { "type": "string" }, "queueName": { "type": "string", "nullable": true }, "runNumber": { "type": "integer", "nullable": true }, "partitionName": { "type": "string", "nullable": true }, "enableDirtyTracking": { "type": "boolean", "nullable": true }, "agentOption1": { "anyOf": [ { "type": "object", "nullable": true }, { "type": "boolean", "nullable": true } ] }, "jobSize": { "type": "integer" } } }, "jobType": { "type": "string" }, "uuid": { "type": "string" }, "calculableObjectTypedId": { "type": "string" }, "queueName": { "type": "string", "nullable": true }, "runNumber": { "type": "integer" }, "partitionName": { "type": "string" }, "partitionUUID": { "type": "string" }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "anyOf": [ { "type": "object", "nullable": true }, { "type": "boolean", "nullable": true } ] }, "jobSize": { "type": "integer" }, "distributed": { "type": "boolean" } } }, "calculationContext": { "type": "string", "maxLength": 255, "nullable": true }, "threadUUID": { "type": "string", "maxLength": 255, "nullable": true }, "id": { "type": "integer" }, "calculationResults": { "type": "string", "description": "Returned only when a JST is fetched using **fetch/JST/{id}** and **fetch/JST** endpoints.\nUse the **admin.fetchjst** endpoint to fetch the JSTs without possibly large `calculationsResults`, `parameters` and `messages` fields.\n", "nullable": true }, "processingNode": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "jobName": { "type": "string", "maxLength": 255 }, "concurrencyKey": { "type": "string", "maxLength": 255 }, "priority": { "type": "integer" }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "processingEnd": { "type": "string", "nullable": true }, "progress": { "type": "string", "maxLength": 255, "nullable": true }, "messages": { "type": "string", "description": "Returned only when a JST is fetched using **fetch/JST/{id}** and **fetch/JST** endpoints.\nUse the **admin.fetchjst** endpoint to fetch the JSTs without possibly large `calculationsResults`, `parameters` and `messages` fields.\n", "nullable": true }, "runNumber": { "type": "integer" }, "cancelRequested": { "type": "boolean" }, "parameters": { "type": "string", "description": "Returned only when a JST is fetched using **fetch/JST/{id}** and **fetch/JST** endpoints.\nUse the **admin.fetchjst** endpoint to fetch the JSTs without possibly large `calculationsResults`, `parameters` and `messages` fields.\n", "nullable": true }, "status": { "type": "string", "maxLength": 255, "enum": [ "WAITING_FOR_DISPATCH", "QUEUED_FOR_EXECUTION", "PROCESSING", "FAILED", "FINISHED", "CANCELLED", "INTERRUPTED" ] }, "lastUpdateBy": { "type": "integer" } } }, "LivePriceGridType": { "type": "object", "title": "LivePriceGridType", "description": "The type code is PGTT", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "targetDate": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "elementNames": { "type": "array", "items": { "type": "string" } }, "dynamicItemMode": { "type": "string" }, "approvalMappings": { "type": "array", "items": {} }, "overridableFields": { "type": "array", "items": {} }, "resultElementName": { "type": "string" }, "hiddenElementNames": { "type": "array", "items": {} }, "shotgunModeEnabled": { "type": "boolean" }, "allowFieldTypeChange": { "type": "boolean" }, "approvalTriggerFields": { "type": "array", "items": {} }, "calculationLogicInputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" } } } }, "userCanToggleVisibility": { "type": "array", "items": { "type": "string" } }, "calcLogicInputsOverridableFields": { "type": "array", "items": { "type": "string" } } } }, "buttonsConfiguration": { "type": "object" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "contextualActions": { "type": "object" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "id": { "type": "integer" } } }, "LoginAuditTrail": { "title": "LoginAuditTrail", "description": "The type code is LAT", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "clientIP": { "type": "string", "maxLength": 255 }, "details": { "type": "string", "maxLength": 20 }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "timestamp": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "LookupTable": { "title": "LookupTable", "description": "The type code is LT", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "owner": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "numberOfKeyFields": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "isPlasma": { "type": "boolean" }, "hideWarnings": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "maxLength": 255, "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "version": { "type": "integer" }, "simulationSet": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "valueType": { "type": "string", "maxLength": 255, "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "id": { "type": "integer" }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "nodeId": { "type": "integer" }, "validAfter": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "SIMULATIONONLY", "INACTIVE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "LookupTableTree": { "title": "LookupTableTree", "description": "The type code is LTT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "LookupTableValue": { "title": "LookupTableValue", "description": "The type code is LTV", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "upperBound": { "type": "number" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "version": { "type": "integer" }, "rawValue": { "type": "string" }, "createdBy": { "type": "integer" }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "name": { "type": "string" }, "tableId": { "type": "integer" }, "lowerBound": { "type": "number" }, "value": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Message": { "title": "Message", "description": "The type code is M", "type": "object", "properties": { "typedId": { "type": "string" }, "clicUniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "conversationId": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "definition": { "type": "object", "properties": { "sender": { "type": "string" }, "createdByName": { "type": "string" }, "createdByUserName": { "type": "string" }, "recipients": { "type": "object", "additionalProperties": { "type": "string" } } } }, "body": { "type": "string", "maxLength": 3000 }, "version": { "type": "integer" }, "clicTypeCode": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ModelClass": { "title": "ModelClass", "description": "The type code is MC", "type": "object", "properties": { "lastUpdateByName": { "type": "string" }, "createdByName": { "type": "string" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "definition": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue": { "title": "MatrixLookupTableValue", "description": "The type code is MLTV", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue2Key": { "title": "MatrixLookupTableValue2Key", "description": "The type code is MLTV2", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "key1": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue3Key": { "title": "MatrixLookupTableValue3Key", "description": "The type code is MLTV3", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "key1": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "key3": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue4Key": { "title": "MatrixLookupTableValue4Key", "description": "The type code is MLTV4", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "key1": { "type": "string", "maxLength": 150 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 150 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "key3": { "type": "string", "maxLength": 150 }, "attribute15": { "type": "string", "maxLength": 255 }, "key4": { "type": "string", "maxLength": 150 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue5Key": { "title": "MatrixLookupTableValue5Key", "description": "The type code is MLTV5", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "key1": { "type": "string", "maxLength": 100 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 100 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "key5": { "type": "string", "maxLength": 100 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "key3": { "type": "string", "maxLength": 100 }, "attribute15": { "type": "string", "maxLength": 255 }, "key4": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "tableId": { "type": "integer" }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableValue6Key": { "title": "MatrixLookupTableValue6Key", "description": "The type code is MLTV6", "type": "object", "properties": { "key1": { "type": "string", "maxLength": 100 }, "createdByName": { "type": "string", "maxLength": 255 }, "key2": { "type": "string", "maxLength": 100 }, "typedId": { "type": "string" }, "key5": { "type": "string", "maxLength": 100 }, "key6": { "type": "string", "maxLength": 100 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "key3": { "type": "string", "maxLength": 100 }, "key4": { "type": "string", "maxLength": 100 }, "type": { "type": "string", "enum": [ "SIMPLE", "RANGE", "MATRIX", "SIMPLE_INT_KEY", "SIMPLE_REAL_KEY", "SIMPLE_DATE_KEY", "JSON" ] }, "valueType": { "type": "string", "enum": [ "STRING", "INT", "REAL", "MATRIX", "DATE", "MATRIX2", "MATRIX3", "MATRIX4", "MATRIX5", "MATRIX6", "JSON", "JSON2" ] }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string" }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lookupTableTypedId": { "type": "string" }, "createdBy": { "type": "integer" }, "tableId": { "type": "integer" }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "MatrixLookupTableAttributeMeta": { "title": "MatrixLookupTableAttributeMeta", "description": "The type code is MLTVM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "lookupTableId": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ModelNature": { "title": "ModelNature", "description": "The type code is MN", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "modelTypeDefJson": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ModelObject": { "title": "ModelObject", "description": "The Type code is MO.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "nullable": true }, "createdByName": { "type": "string", "nullable": true }, "typedId": { "type": "string" }, "workflowStatus": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time", "nullable": true }, "approvedBy": { "type": "integer", "nullable": true }, "submitDate": { "type": "string", "format": "date-time", "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "submittedByName": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "state": { "type": "object", "nullable": true }, "id": { "type": "integer", "nullable": true }, "createDate": { "type": "string", "format": "date-time", "nullable": true }, "submittedBy": { "type": "integer", "nullable": true }, "deniedBy": { "type": "integer", "nullable": true }, "label": { "type": "string", "maxLength": 255, "nullable": true }, "moduleCategoryUN": { "type": "string", "nullable": true }, "version": { "type": "integer", "nullable": true }, "currentStep": { "type": "string", "maxLength": 255, "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255, "nullable": true }, "createdBy": { "type": "integer", "nullable": true }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "modelClassUN": { "type": "string", "maxLength": 255, "nullable": true }, "status": { "type": "string", "enum": [ "INVALID", "DRAFT", "CALCULATING", "ERROR", "READY" ] }, "lastUpdateBy": { "type": "integer", "nullable": true } } }, "ManualPricelist": { "title": "ManualPricelist", "description": "The type code is MPL", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "expiryDate": { "type": "string", "format": "date-time" }, "simulationSet": { "type": "string", "maxLength": 255 }, "linkedCFStypedId": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "integrationStatus": { "type": "string", "maxLength": 255 }, "nodeId": { "type": "integer" }, "validAfter": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "SIMULATIONONLY", "INACTIVE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ManualPricelistItemAttributeMeta": { "title": "ManualPricelistItemAttributeMeta", "description": "The type code is MPLAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "pricelistId": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ManualPricelistItem": { "title": "ManualPricelistItem", "description": "The type code is MPLI.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "nullable": true }, "typedId": { "type": "string" }, "attribute19": {}, "attribute18": {}, "attribute17": {}, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": {}, "attribute15": {}, "attribute25": {}, "attribute24": {}, "currency": { "type": "string", "maxLength": 255 }, "attribute23": {}, "attribute22": {}, "sku": { "type": "string", "maxLength": 255 }, "attribute21": {}, "attribute20": {}, "createDate": { "type": "string", "format": "date-time" }, "comments": { "type": "string", "maxLength": 255, "nullable": true }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "pricelistId": { "type": "integer" }, "attribute29": {}, "attribute28": {}, "attribute27": {}, "attribute26": {}, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": {}, "attribute8": {}, "attribute5": {}, "createdBy": { "type": "integer" }, "attribute4": {}, "attribute7": {}, "attribute6": {}, "attribute1": {}, "attribute14": {}, "attribute13": {}, "attribute3": {}, "attribute12": {}, "attribute2": {}, "attribute11": {}, "attribute10": {}, "attribute30": {}, "lastUpdateBy": { "type": "integer" } } }, "ManualPricelistIntegrationTag": { "title": "ManualPricelistIntegrationTag", "description": "The type code is MPLIT", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ManualPricelistTree": { "title": "ManualPricelistTree", "description": "The type code is MPLT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ModelRecord": { "title": "ModelRecord", "description": "The type code is MR", "type": "object", "properties": { "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "modelId": { "type": "integer" }, "endDate": { "type": "string", "format": "date-time" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "rank": { "type": "integer" }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "targetDate": { "type": "string", "format": "date-time" }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "messages": { "type": "array", "items": { "type": "string" } }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "startDate": { "type": "string", "format": "date-time" }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "APPROVED", "REVOKED" ] }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "formulaName": { "type": "string", "maxLength": 255 }, "itemExtensions": { "type": "string" }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationDate": { "type": "string", "format": "date-time" }, "manualOverrides": { "type": "string" }, "parentTypedId": { "type": "string" }, "calculationBaseAsAdvancedFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "submittedByName": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "string", "nullable": true } }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "key2": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "deniedByName": { "type": "string" }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "approvedByName": { "type": "string" }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "uniqueName": { "type": "string", "maxLength": 255 }, "calculatedResultPrice": { "type": "number" }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "productFilterString": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationBaseJson": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time" }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "description": { "type": "string" }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "customerFilterString": { "type": "string" }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "ModelRecordAttributeMeta": { "title": "ModelRecordAttributeMeta", "description": "The type code is MRAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "modelId": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ModelType": { "title": "ModelType", "description": "The type code is MT", "type": "object", "properties": { "modelNature": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "modelTypeDefJson": { "type": "string" } } }, "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "modelTypeDefJson": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "modelNatureUN": { "type": "string", "maxLength": 255 }, "modelTypeDef": { "type": "object", "properties": { "logic": { "type": "string" }, "libLogic": { "type": "string" }, "analysisLogic": { "type": "string" }, "evalLogic": { "type": "string" }, "recordLogic": { "type": "string" }, "generatesData": { "type": "boolean" }, "generatesTables": { "type": "boolean" }, "generatesRecords": { "type": "boolean" }, "generatesTrees": { "type": "boolean" }, "calcSteps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "category": { "type": "string" }, "logic": { "type": "string" }, "distributed": { "type": "boolean" } } } } } }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Note": { "title": "Note", "description": "The type code is NT", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "summary": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "parentTypedId": { "type": "string", "maxLength": 255 }, "description": { "type": "string" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Notification": { "title": "Notification", "description": "The type code is NTF.", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "isRead": { "type": "boolean" }, "source": { "type": "string", "maxLength": 255 }, "title": { "type": "string", "maxLength": 255 }, "message": { "type": "string", "maxLength": 4096 }, "version": { "type": "integer" }, "actionLabel": { "type": "string", "maxLength": 255, "nullable": true }, "actionType": { "type": "string", "maxLength": 255, "enum": [ "UNKNOWN", "LINK", "DOWNLOAD", "INFO_MESSAGE", "MESSAGE_LINK", "CTX_LINK" ] }, "createdBy": { "type": "integer" }, "topic": { "type": "string", "maxLength": 255, "enum": [ "VALIDATION", "CALCULATION", "DATA_DOWNLOAD", "MESSAGE", "GROOVY", "SYSTEM_NOTIFICATION" ], "example": "VALIDATION" }, "action": { "type": "string", "maxLength": 2000, "nullable": true }, "recipientID": { "type": "integer" }, "validUntil": { "type": "string", "format": "date-time", "maxLength": 255 }, "status": { "type": "string", "maxLength": 255, "enum": [ "UNKNOWN", "INFO", "WARNING", "ERROR", "SUCCESS" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ParallelCalculationItem": { "title": "ParallelCalculationItem", "type": "object", "description": "The type code is PCI.", "properties": { "lastUpdateByName": { "type": "string" }, "outputs": { "type": "array", "description": "Returned only when a PCI is fetched using **fetch/PCI/{id}** and **fetch/PCI** endpoints. Use the **optimization.modelfetchpci** endpoint to fetch the PCIs without possibly large `outputs` and `messages` fields.", "nullable": true, "items": {} }, "createdByName": { "type": "string" }, "typedId": { "type": "string" }, "inputs": { "type": "object", "properties": { "additionalProperties": { "type": "object" } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "jstId": { "type": "integer" }, "createdBy": { "type": "integer" }, "messages": { "type": "array", "description": "Returned only when a PCI is fetched using **fetch/PCI/{id}** and **fetch/PCI** endpoints. Use the **optimization.modelfetchpci** endpoint to fetch the PCIs without possibly large `outputs` and `messages` fields.", "nullable": true, "items": {} }, "key": { "type": "string", "maxLength": 255 }, "status": { "type": "string", "maxLength": 255, "enum": [ "CREATED", "CALCULATED", "FAILED" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Product": { "title": "Product", "description": "The Product object. The Type code is P.

\n**MassEditable**: yes
\n**bulkLoadable**: yes", "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "currency": { "maxLength": 255, "type": "string", "nullable": true }, "formulaName": { "maxLength": 255, "type": "string", "nullable": true }, "image": { "type": "boolean", "nullable": true }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "sku": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "unitOfMeasure": { "maxLength": 255, "type": "string", "nullable": true }, "userGroupEdit": { "maxLength": 255, "type": "string", "nullable": true }, "userGroupViewDetails": { "maxLength": 255, "type": "string", "nullable": true }, "version": { "type": "integer" }, "attribute1": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute2": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute3": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute4": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute5": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute6": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute7": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute8": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute9": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute10": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute11": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute12": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute13": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute14": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute15": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute16": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute17": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute18": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute19": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute20": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute21": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute22": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute23": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute24": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute25": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute26": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute27": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute28": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute29": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] }, "attribute30": { "anyOf": [ { "type": "integer", "nullable": true }, { "type": "string", "maxLength": 255, "nullable": true }, { "type": "number", "nullable": true }, { "type": "string", "format": "date-time", "maxLength": 255, "nullable": true }, { "type": "string", "format": "date", "maxLength": 255, "nullable": true }, { "type": "string", "format": "uri", "maxLength": 255, "nullable": true } ] } } }, "ProductArray": { "title": "ProductArray", "description": "The Product object. The type code is P.", "type": "string" }, "ProductAttributeMeta": { "title": "ProductAttributeMeta", "description": "The type code is PAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ProductBoMEntry": { "title": "ProductBoMEntry", "description": "The type code is PBOME", "type": "object", "properties": { "additionalInfo4": { "type": "string", "maxLength": 255 }, "subComponentSku": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "additionalInfo2": { "type": "number" }, "typedId": { "type": "string" }, "quantity": { "type": "number" }, "additionalInfo1": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "rawMaterial": { "type": "string", "maxLength": 255 }, "type": { "type": "string", "maxLength": 255, "enum": [ "SUBCOMPONENT", "RAWMATERIAL" ] }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "sku": { "type": "string", "maxLength": 255 }, "category": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ProductCompetition": { "title": "ProductCompetition", "description": "The ProductCompetition object. The type code is PCOMP.", "type": "object", "properties": { "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo3": { "maxLength": 255, "type": "string" }, "additionalInfo4": { "maxLength": 255, "type": "string" }, "comments": { "maxLength": 255, "type": "string" }, "competitionType": { "maxLength": 255, "type": "string" }, "competitor": { "maxLength": 255, "type": "string" }, "competitorSku": { "maxLength": 255, "type": "string" }, "country": { "maxLength": 255, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "currency": { "maxLength": 255, "type": "string" }, "infoDate": { "format": "date-time", "type": "string" }, "integrationToken": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "price": { "type": "number" }, "priceAPIRecord": { "type": "string" }, "priceType": { "maxLength": 255, "type": "string" }, "priceUnit": { "type": "number" }, "priority": { "type": "integer" }, "sku": { "maxLength": 255, "type": "string" }, "source": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "unitOfMeasure": { "maxLength": 255, "type": "string" }, "version": { "type": "integer" } } }, "ProductCompetitionConfig": { "title": "ProductCompetitionConfig", "description": "The type code is PCOMPCO", "type": "object", "properties": { "filterCriteria": { "type": "string" }, "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "options": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "fieldsMapping": { "type": "string" }, "version": { "type": "integer" }, "structure": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PendingCreationWorkflow": { "title": "PendingCreationWorkflow", "description": "The type code is PCW", "type": "object", "properties": { "typedId": { "type": "string" }, "documentLabel": { "type": "string", "maxLength": 255 }, "hidden": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "userLoginName": { "type": "string", "maxLength": 255 }, "documentUniqueName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "stepLabel": { "type": "string", "maxLength": 255 }, "documentTypedId": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ProductDescription": { "title": "ProductDescription", "description": "The type code is PDESC", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "sku": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PriceGrid": { "title": "PriceGrid", "description": "The type code is PG", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "configuration": { "type": "string" }, "relativeTargetDateDays": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "numberOfSubmittedItems": { "type": "integer" }, "description": { "type": "string", "maxLength": 255 }, "numberOfAutoApprovedItems": { "type": "integer" }, "locale": { "type": "string", "maxLength": 255 }, "numberOfDeniedItems": { "type": "integer" }, "calculationDate": { "type": "string", "format": "date-time" }, "writeOnlyChangedItems": { "type": "boolean" }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "id": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "headerTypeUniqueName": { "type": "string", "maxLength": 255 }, "calculationMessages": { "type": "string" }, "updatedBy": { "type": "integer" }, "numberOfApprovedItems": { "type": "integer" }, "targetDate": { "type": "string", "format": "date-time" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "partialCalculationDate": { "type": "string", "format": "date-time" }, "numberOfOpenItems": { "type": "integer" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "integrationStatus": { "type": "string", "maxLength": 255 }, "priceGridType": { "type": "string", "maxLength": 255, "enum": [ "SIMPLE", "MATRIX" ] }, "nodeId": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "PriceGridItem": { "title": "PriceGridItem", "description": "The type code is PGI", "type": "object", "properties": { "denialDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "activePriceDate": { "type": "string", "format": "date-time" }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "denialReason": { "type": "string", "maxLength": 255 }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChangePct_ActivePrev": { "type": "number" }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "manualEditUser": { "type": "integer" }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "manualPriceExpired": { "type": "boolean" }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "manualPriceDate": { "type": "string", "format": "date-time" }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "itemExtensions": { "type": "string" }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "manualOverrides": { "type": "string" }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "submittedByName": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "activePrice": { "type": "number" }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "string", "nullable": true } }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "previousPriceDate": { "type": "string", "format": "date-time" }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "key2": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "deniedByName": { "type": "string" }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "approvedByName": { "type": "string" }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "calculatedResultPrice": { "type": "number" }, "manualEditVersion": { "type": "integer" }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "approvalDate": { "type": "string", "format": "date-time" }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "submitDate": { "type": "string", "format": "date-time" }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "priceChange_ActivePrev": { "type": "number" }, "priceGridId": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "PriceGridItemAttributeMeta": { "title": "PriceGridItemAttributeMeta", "description": "The type code is PGIM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "hidden": { "type": "boolean" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "manual": { "type": "boolean" }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "inputAttribute": { "type": "boolean" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "priceGridId": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PriceGridTree": { "title": "PriceGridTree", "description": "The type code is PGT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PartitionHelp": { "title": "PartitionHelp", "description": "The type code is PH", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "value": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Pricelist": { "title": "Pricelist", "description": "The type code is PL.", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255 }, "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time" }, "configuration": { "type": "string" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "submitDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "jstId": { "type": "integer" }, "deniedByName": { "type": "string" }, "writeOnlyChangedItems": { "type": "boolean" }, "expiryDate": { "type": "string", "format": "date-time" }, "pricelistType": { "type": "string", "maxLength": 255, "enum": [ "SIMPLE", "MATRIX" ] }, "submittedByName": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "approvedByName": { "type": "string" }, "id": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "previousPricelistId": { "type": "integer" }, "calculationMessages": { "type": "string" }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "string", "nullable": true } }, "updatedBy": { "type": "integer" }, "targetDate": { "type": "string", "format": "date-time" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "errorMode": { "type": "string", "maxLength": 255, "enum": [ "ABORT", "SKIP" ] }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "exportDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "integrationStatus": { "type": "string", "maxLength": 255 }, "nodeId": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "PricelistItem": { "title": "PricelistItem", "description": "The type code is PLI.", "type": "object", "properties": { "typedId": { "type": "string" }, "listLabel": { "type": "string" }, "resultPrice": { "type": "number", "nullable": true }, "priceChangePct": { "type": "number", "nullable": true }, "attribute83": { "type": "string", "maxLength": 70, "nullable": true }, "attribute82": { "type": "string", "maxLength": 70, "nullable": true }, "attribute81": { "type": "string", "maxLength": 70, "nullable": true }, "attribute80": { "type": "string", "maxLength": 70, "nullable": true }, "attribute89": { "type": "string", "maxLength": 70, "nullable": true }, "attribute88": { "type": "string", "maxLength": 70, "nullable": true }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "maxLength": 70, "nullable": true }, "attribute86": { "type": "string", "maxLength": 70, "nullable": true }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "maxLength": 70, "nullable": true }, "attribute84": { "type": "string", "maxLength": 70, "nullable": true }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "targetDate": { "type": "string", "format": "date-time" }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string", "nullable": true }, "attribute9": { "type": "string", "maxLength": 70, "nullable": true }, "attribute94": { "type": "string", "maxLength": 70, "nullable": true }, "attribute8": { "type": "string", "maxLength": 70, "nullable": true }, "attribute93": { "type": "string", "maxLength": 70, "nullable": true }, "attribute92": { "type": "string", "maxLength": 70, "nullable": true }, "attribute91": { "type": "string", "maxLength": 70, "nullable": true }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "maxLength": 70, "nullable": true }, "attribute4": { "type": "string", "maxLength": 70, "nullable": true }, "attribute7": { "type": "string", "maxLength": 70, "nullable": true }, "attribute6": { "type": "string", "maxLength": 70, "nullable": true }, "attribute1": { "type": "string", "maxLength": 70, "nullable": true }, "attribute14": { "type": "string", "maxLength": 70, "nullable": true }, "attribute13": { "type": "string", "maxLength": 70, "nullable": true }, "attribute3": { "type": "string", "maxLength": 70, "nullable": true }, "attribute12": { "type": "string", "maxLength": 70, "nullable": true }, "attribute2": { "type": "string", "maxLength": 70, "nullable": true }, "attribute11": { "type": "string", "maxLength": 70, "nullable": true }, "attribute99": { "type": "string", "maxLength": 70, "nullable": true }, "attribute10": { "type": "string", "maxLength": 70, "nullable": true }, "attribute98": { "type": "string", "maxLength": 70, "nullable": true }, "attribute97": { "type": "string", "maxLength": 70, "nullable": true }, "attribute96": { "type": "string", "maxLength": 70, "nullable": true }, "attribute95": { "type": "string", "maxLength": 70, "nullable": true }, "updateDate": { "type": "string", "format": "date" }, "itemExtensions": { "type": "object", "nullable": true }, "attribute19": { "type": "string", "maxLength": 70, "nullable": true }, "attribute18": { "type": "string", "maxLength": 70, "nullable": true }, "attribute17": { "type": "string", "maxLength": 70, "nullable": true }, "attribute16": { "type": "string", "maxLength": 70, "nullable": true }, "attribute15": { "type": "string", "maxLength": 70, "nullable": true }, "manualOverrides": { "type": "string", "nullable": true }, "attribute25": { "type": "string", "maxLength": 70, "nullable": true }, "attribute24": { "type": "string", "maxLength": 70, "nullable": true }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 70, "nullable": true }, "attribute22": { "type": "string", "maxLength": 70, "nullable": true }, "attribute21": { "type": "string", "maxLength": 70, "nullable": true }, "attribute20": { "type": "string", "maxLength": 70, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 70, "nullable": true }, "attribute28": { "type": "string", "maxLength": 70, "nullable": true }, "attribute27": { "type": "string", "maxLength": 70, "nullable": true }, "attribute26": { "type": "string", "maxLength": 70, "nullable": true }, "completeResultsAvailable": { "type": "boolean" }, "attribute36": { "type": "string", "maxLength": 70, "nullable": true }, "attribute35": { "type": "string", "maxLength": 70, "nullable": true }, "attribute34": { "type": "string", "maxLength": 70, "nullable": true }, "attribute33": { "type": "string", "maxLength": 70, "nullable": true }, "attribute32": { "type": "string", "maxLength": 70, "nullable": true }, "attribute31": { "type": "string", "maxLength": 70, "nullable": true }, "attribute30": { "type": "string", "maxLength": 70, "nullable": true }, "key2": { "type": "string", "nullable": true }, "attribute39": { "type": "string", "maxLength": 70, "nullable": true }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "maxLength": 70, "nullable": true }, "attribute37": { "type": "string", "maxLength": 70, "nullable": true }, "attribute47": { "type": "string", "maxLength": 70, "nullable": true }, "attribute46": { "type": "string", "maxLength": 70, "nullable": true }, "attribute45": { "type": "string", "maxLength": 70, "nullable": true }, "attribute44": { "type": "string", "maxLength": 70, "nullable": true }, "attribute43": { "type": "string", "maxLength": 70, "nullable": true }, "attribute42": { "type": "string", "maxLength": 70, "nullable": true }, "attribute41": { "type": "string", "maxLength": 70, "nullable": true }, "attribute40": { "type": "string", "maxLength": 70, "nullable": true }, "priceChange": { "type": "number", "nullable": true }, "updatedBy": { "type": "integer" }, "attribute49": { "type": "string", "maxLength": 70, "nullable": true }, "attribute48": { "type": "string", "maxLength": 70, "nullable": true }, "attribute50": { "type": "string", "maxLength": 70, "nullable": true }, "attribute100": { "type": "string", "maxLength": 70, "nullable": true }, "calculatedResultPrice": { "type": "number", "nullable": true }, "attribute58": { "type": "string", "maxLength": 70, "nullable": true }, "attribute57": { "type": "string", "maxLength": 70, "nullable": true }, "attribute56": { "type": "string", "maxLength": 70, "nullable": true }, "attribute55": { "type": "string", "maxLength": 70, "nullable": true }, "attribute54": { "type": "string", "maxLength": 70, "nullable": true }, "attribute53": { "type": "string", "maxLength": 70, "nullable": true }, "attribute52": { "type": "string", "maxLength": 70, "nullable": true }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "maxLength": 70, "nullable": true }, "attribute59": { "type": "string", "maxLength": 70, "nullable": true }, "attribute61": { "type": "string", "maxLength": 70, "nullable": true }, "attribute60": { "type": "string", "maxLength": 70, "nullable": true }, "previousPrice": { "type": "number", "nullable": true }, "attribute69": { "type": "string", "maxLength": 70, "nullable": true }, "attribute68": { "type": "string", "maxLength": 70, "nullable": true }, "attribute67": { "type": "string", "maxLength": 70, "nullable": true }, "attribute66": { "type": "string", "maxLength": 70, "nullable": true }, "attribute65": { "type": "string", "maxLength": 70, "nullable": true }, "attribute64": { "type": "string", "maxLength": 70, "nullable": true }, "attribute63": { "type": "string", "maxLength": 70, "nullable": true }, "attribute62": { "type": "string", "maxLength": 70, "nullable": true }, "workStatus": { "type": "string", "maxLength": 15, "nullable": true }, "manualResultPrice": { "type": "number", "nullable": true }, "comments": { "type": "string", "maxLength": 255 }, "pricelistId": { "type": "integer" }, "warnings": { "type": "string" }, "approvalState": { "type": "integer" }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "maxLength": 70, "nullable": true }, "attribute71": { "type": "string", "maxLength": 70, "nullable": true }, "attribute70": { "type": "string", "maxLength": 70, "nullable": true }, "createdBy": { "type": "integer" }, "attribute79": { "type": "string", "maxLength": 70, "nullable": true }, "attribute78": { "type": "string", "maxLength": 70, "nullable": true }, "attribute77": { "type": "string", "maxLength": 70, "nullable": true }, "attribute76": { "type": "string", "maxLength": 70, "nullable": true }, "attribute75": { "type": "string", "maxLength": 70, "nullable": true }, "attribute74": { "type": "string", "maxLength": 70, "nullable": true }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "maxLength": 70, "nullable": true } } }, "PricelistItemAttributeMeta": { "title": "PricelistItemAttributeMeta", "description": "The type code is PLIM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "pricelistId": { "type": "integer" }, "hidden": { "type": "boolean" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "inputAttribute": { "type": "boolean" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PricelistTree": { "title": "PricelistTree", "description": "The type code is PLT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PriceListType": { "type": "object", "title": "PriceListType", "description": "The type code is PLTT", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "createdByName": { "type": "string" }, "lastUpdateByName": { "type": "string" }, "targetDate": { "type": "string" }, "typeConfiguration": { "type": "object", "properties": { "errorMode": { "type": "string" }, "elementNames": { "type": "array", "items": { "type": "string" } }, "overridableFields": { "type": "array", "items": {} }, "resultElementName": { "type": "string" }, "hiddenElementNames": { "type": "array", "items": {} }, "notifyWhenFinished": { "type": "string" }, "shotgunModeEnabled": { "type": "boolean" }, "calculationLogicInputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" } } } }, "userCanToggleVisibility": { "type": "array", "items": {} }, "calcLogicInputsOverridableFields": { "type": "array", "items": {} } } }, "buttonsConfiguration": { "type": "object" }, "headerFormulaName": { "type": "string" }, "dimensionType": { "type": "string" }, "calculationFormulaName": { "type": "string" }, "contextualActions": { "type": "object" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "id": { "type": "integer" } } }, "PriceRecord": { "title": "PriceRecord", "description": "The type code is PR", "type": "object", "properties": { "sourceId": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "externalRef": { "type": "string", "maxLength": 255 }, "sourceIdNoRev": { "type": "string" }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "priority": { "type": "integer" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "REVOKED", "INVALIDATED" ] }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "expiryDate": { "type": "string", "format": "date-time" }, "customerId": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "validAfter": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "lineId": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "PriceRecordAttributeMeta": { "title": "PriceRecordAttributeMeta", "description": "The type code is PRAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Preferences": { "title": "Preferences", "description": "The type code is PREF", "type": "object", "properties": { "areGlobal": { "type": "boolean" }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "preferenceType": { "type": "string" }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "filter": { "type": "string" }, "columnLabels": { "type": "string" }, "createdBy": { "type": "integer" }, "preferenceName": { "type": "string" }, "viewState": { "type": "string" }, "areDefault": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Partition": { "title": "Partition", "description": "The type code is PT", "type": "object", "properties": { "globalObjectTypeArray": { "type": "array", "items": { "type": "string" } }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "disableBackgroundJobs": { "type": "boolean" }, "maxRebateManagerUsers": { "type": "integer" }, "uuid": { "type": "string", "maxLength": 10 }, "maxPriceShopUsers": { "type": "integer" }, "maxPriceOptimizationUsers": { "type": "integer" }, "csEnabled": { "type": "boolean" }, "maxContractManagerUsers": { "type": "integer" }, "maxClaimManagerUsers": { "type": "integer" }, "id": { "type": "integer" }, "baseUOMCode": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "globalPartitionName": { "type": "string", "maxLength": 255 }, "globalObjectTypes": { "type": "string", "maxLength": 255 }, "eventBitMask": { "type": "integer" }, "customSchemaInfo": { "type": "string", "maxLength": 255 }, "csrfBlockerUserAgentExclusions": { "type": "string", "maxLength": 255 }, "maxAdminUsers": { "type": "integer" }, "paDbName": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "paDbHosts": { "type": "string", "maxLength": 255 }, "csrfBlockerEnabled": { "type": "boolean" }, "version": { "type": "integer" }, "eventsToMQ": { "type": "string", "maxLength": 255 }, "maxPriceBuilderUsers": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "baseCurrencyCode": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "internalEventBitMask": { "type": "integer" }, "globalPartitionExtensions": { "type": "string", "maxLength": 255 }, "rserver": { "type": "string" }, "maxAnalyticsUsers": { "type": "integer" }, "lastUpdateBy": { "type": "integer" } } }, "PasswordHistory": { "title": "PasswordHistory", "description": "The type code is PWH", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "userId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PX10": { "title": "PX10", "description": "The type code is PX10", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PX20": { "title": "PX20", "description": "The type code is PX20", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "PX3": { "title": "PX3", "description": "The type code is PX3.", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 255 }, "attribute1": {}, "attribute3": {}, "attribute2": {}, "sku": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PX30": { "title": "PX30", "description": "The type code is PX30", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "PX50": { "title": "PX50", "description": "The type code is PX50.", "type": "object", "properties": { "typedId": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" } } }, "PX6": { "title": "PX6", "description": "The type code is PX6", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "PX8": { "title": "PX8", "description": "The type code is PX8", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "attribute8": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "sku": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ProductExtensionAttributeMeta": { "title": "ProductExtensionAttributeMeta", "description": "The type code is PXAM.", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ProductXReference": { "title": "ProductXReference", "description": "The ProductXReference object. The type code is PXREF.", "type": "object", "properties": { "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo3": { "maxLength": 255, "type": "string" }, "additionalInfo4": { "maxLength": 255, "type": "string" }, "comments": { "maxLength": 255, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "infoDate": { "format": "date-time", "type": "string" }, "internalReference": { "type": "boolean" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "referenceType": { "maxLength": 255, "type": "string" }, "sku": { "maxLength": 255, "type": "string" }, "targetSku": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" } } }, "PayoutRecord": { "title": "PayoutRecord", "description": "The type code is PYR", "type": "object", "properties": { "typedId": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "type": { "type": "string", "maxLength": 255 }, "intgStatus": { "type": "string", "maxLength": 255 }, "payoutDate": { "type": "string", "format": "date-time" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "intgStatusDetails": { "type": "string", "maxLength": 255 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "startDate": { "type": "string", "format": "date-time" }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "status": { "type": "string", "maxLength": 255 }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "intgStatusErpReference": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "rebateType": { "type": "string" }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "lastStatusUpdateDate": { "type": "string", "format": "date-time" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "label": { "type": "string" }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "rebateRecordUN": { "type": "string", "maxLength": 255 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "PayoutRecordAttributeMeta": { "title": "PayoutRecordAttributeMeta", "description": "The type code is PYRAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Quote": { "title": "Quote", "description": "The type code is Q.", "type": "object", "properties": { "outputs": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "headerText": { "type": "string" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "inputs": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "serverMessagesExtended": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" } } } }, "externalRef": { "type": "string", "maxLength": 255, "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object" } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "parentId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "containsProductImage": { "type": "boolean" }, "sku": { "type": "string" }, "priceRecordId": { "type": "integer" }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "creationWorkflowCurrentStep": { "type": "integer", "nullable": true }, "rootUniqueName": { "type": "string" }, "originUniqueName": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "format": "date", "nullable": true }, "customerGroup": { "type": "string", "nullable": true }, "ioMeta": { "anyOf": [ { "type": "object" }, { "type": "string" } ] }, "originDeleted": { "type": "boolean", "nullable": true }, "version": { "type": "integer" }, "customerName": { "type": "string", "maxLength": 255, "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255 }, "serverMessages": { "type": "array", "nullable": true, "items": { "type": "string" } }, "creationWorkflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "INPROGRESS", "FINISHED" ] }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "originClicId": { "type": "integer", "nullable": true }, "renderInfo": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "lostReason": { "type": "string", "maxLength": 255, "nullable": true }, "signature": { "type": "object", "nullable": true, "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "delivered", "signed", "completed", "declined", "voided", "processing", "error", "cancelling" ] }, "sentDateTime": { "type": "string" }, "statusChangedDateTime": { "type": "string" }, "customerName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "sender": { "type": "integer" }, "senderName": { "type": "string" }, "templateName": { "type": "string" }, "note": { "type": "string" }, "voidedReason": { "type": "string" }, "error": { "type": "string" }, "history": { "type": "array", "items": { "type": "object" } } } }, "creationWorkflowStepCount": { "type": "integer", "nullable": true }, "quoteType": { "type": "string", "nullable": true }, "quoteStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "OFFER", "DEAL", "REVOKED", "SUPERSEDED", "INVALIDATED", "LOST", "PARTIALDEAL" ] }, "lostReasonComment": { "type": "string", "maxLength": 255, "nullable": true }, "expiryDate": { "type": "string", "format": "date", "nullable": true }, "creationWorkflowStepLabel": { "type": "string", "maxLength": 255, "nullable": true }, "customerId": { "type": "string", "maxLength": 255, "nullable": true }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "additionalInfo4": { "type": "string", "maxLength": 255, "nullable": true }, "additionalInfo3": { "type": "string", "maxLength": 255, "nullable": true }, "refreshInputs": { "type": "boolean" }, "additionalInfo2": { "type": "number", "nullable": true }, "additionalInfo1": { "type": "number", "nullable": true }, "numberOfAttachments": { "type": "integer" }, "originLabel": { "type": "string", "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "integer" }, "approvalRequiredEmailAttachmentsJson": { "type": "string", "nullable": true }, "viewState": { "type": "object", "nullable": true, "properties": { "gridViewState": { "type": "string" }, "openFolders": { "type": "array", "items": { "type": "string" } }, "selectedNodes": { "type": "array", "items": { "type": "string" } } } }, "prevRev": { "type": "string", "nullable": true }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string", "nullable": true }, "lastUpdateBy": { "type": "integer" }, "persistedClicId": { "type": "integer", "nullable": true }, "persistedClicVersion": { "type": "integer" } } }, "quoteTmp": { "title": "quoteTemp", "description": "The type code is QTMP.", "type": "object", "properties": { "outputs": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "headerText": { "type": "string", "nullable": true }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "inputs": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "type": { "type": "string" }, "value": { "type": "object", "nullable": true }, "valueHint": { "type": "string", "nullable": true }, "readOnly": { "type": "boolean", "nullable": true }, "filter": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "parameterGroup": { "type": "string", "nullable": true }, "required": { "type": "boolean", "nullable": true }, "labelTranslations": { "type": "string", "nullable": true }, "addUnknownValues": { "type": "boolean", "nullable": true }, "typedId": { "type": "string", "nullable": true }, "alwaysEditable": { "type": "boolean", "nullable": true }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "nullable": true, "items": {} } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "serverMessagesExtended": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" } } } }, "externalRef": { "type": "string", "maxLength": 255, "nullable": true }, "deniedByName": { "type": "string", "nullable": true }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object" } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "parentId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "containsProductImage": { "type": "boolean" }, "sku": { "type": "string" }, "priceRecordId": { "type": "integer" }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "creationWorkflowCurrentStep": { "type": "integer", "nullable": true }, "rootUniqueName": { "type": "string" }, "originUniqueName": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "format": "date", "nullable": true }, "customerGroup": { "type": "string", "nullable": true }, "ioMeta": { "type": "object", "nullable": true }, "originDeleted": { "type": "boolean", "nullable": true }, "version": { "type": "integer" }, "customerName": { "type": "string", "maxLength": 255, "nullable": true }, "uniqueName": { "type": "string", "maxLength": 255 }, "serverMessages": { "type": "array", "nullable": true, "items": { "type": "string" } }, "creationWorkflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "INPROGRESS", "FINISHED" ] }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "originClicId": { "type": "integer", "nullable": true }, "renderInfo": { "type": "object", "additionalProperties": { "type": "object" }, "nullable": true }, "lostReason": { "type": "string", "maxLength": 255, "nullable": true }, "signature": { "type": "object", "nullable": true, "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "delivered", "signed", "completed", "declined", "voided", "processing", "error", "cancelling" ] }, "sentDateTime": { "type": "string" }, "statusChangedDateTime": { "type": "string" }, "customerName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "sender": { "type": "integer" }, "senderName": { "type": "string" }, "templateName": { "type": "string" }, "note": { "type": "string" }, "voidedReason": { "type": "string" }, "error": { "type": "string" }, "history": { "type": "array", "items": { "type": "object" } } } }, "creationWorkflowStepCount": { "type": "integer", "nullable": true }, "quoteType": { "type": "string", "nullable": true }, "quoteStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "OFFER", "DEAL", "REVOKED", "SUPERSEDED", "INVALIDATED", "LOST", "PARTIALDEAL" ] }, "lostReasonComment": { "type": "string", "maxLength": 255, "nullable": true }, "expiryDate": { "type": "string", "format": "date", "nullable": true }, "creationWorkflowStepLabel": { "type": "string", "maxLength": 255, "nullable": true }, "customerId": { "type": "string", "maxLength": 255, "nullable": true }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "additionalInfo4": { "type": "string", "maxLength": 255, "nullable": true }, "additionalInfo3": { "type": "string", "maxLength": 255, "nullable": true }, "refreshInputs": { "type": "boolean" }, "additionalInfo2": { "type": "number", "nullable": true }, "additionalInfo1": { "type": "number", "nullable": true }, "numberOfAttachments": { "type": "integer" }, "originLabel": { "type": "string", "nullable": true }, "label": { "type": "string", "maxLength": 255 }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "createdBy": { "type": "integer" }, "approvalRequiredEmailAttachmentsJson": { "type": "string", "nullable": true }, "viewState": { "type": "object", "nullable": true, "properties": { "gridViewState": { "type": "string", "nullable": true }, "openFolders": { "type": "array", "nullable": true, "items": {} }, "selectedNodes": { "type": "array", "nullable": true, "items": {} } } }, "prevRev": { "type": "string", "nullable": true }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string", "nullable": true }, "lastUpdateBy": { "type": "integer" } } }, "QuoteMassUpdate": { "title": "QuoteMassUpdate", "description": "The type code is QMU", "type": "object", "properties": { "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "configuration": { "type": "object", "properties": { "headerFilter": { "type": "object", "additionalProperties": { "type": "string" } }, "inputsLogic": { "type": "string" }, "headerInputsLogic": { "type": "string" }, "inputUpdateDefs": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "fieldLabel": { "type": "string" }, "op": { "type": "string" }, "value": { "type": "string" }, "desc": { "type": "string" }, "inputType": { "type": "string" } } } }, "headerInputUpdateDefs": { "type": "array", "items": { "type": "object" } }, "outputDefs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" } } } }, "inputDefs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" } } } }, "overridesLogic": { "type": "string" }, "headerOverridesLogic": { "type": "string" }, "inputsLogicParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "headerInputsLogicParams": { "type": "array", "items": { "type": "object" } }, "overridesLogicParams": { "type": "array", "items": { "type": "object" } }, "headerOverridesLogicParams": { "type": "array", "items": { "type": "object" } }, "errorModeType": { "type": "string", "enum": [ "ABORT", "SKIP" ] }, "userNotificationType": { "type": "string", "enum": [ "NONE", "EMAIL" ] }, "autoSubmit": { "type": "boolean" }, "createCopies": { "type": "boolean" }, "comment": { "type": "string" }, "customerGroup": { "type": "object", "additionalProperties": { "type": "string" } }, "productGroup": { "type": "object", "additionalProperties": { "type": "string" } } } }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "templateName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "progress": { "type": "string", "maxLength": 255 }, "massUpdateType": { "type": "string", "maxLength": 255, "enum": [ "SIMULATION", "UPDATE" ] }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "QuoteTree": { "title": "QuoteTree", "description": "The type code is QT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "QuoteMassUpdateItem": { "title": "QuoteMassUpdateItem", "description": "The type code is QMUI", "type": "object", "properties": { "targetUniqueName": { "type": "string", "maxLength": 255 }, "item": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "targetLabel": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "massUpdateId": { "type": "integer" }, "sourceStatus": { "type": "string" }, "createdBy": { "type": "integer" }, "sourceItemLineId": { "type": "string", "maxLength": 255 }, "targetItemLineId": { "type": "string", "maxLength": 255 }, "sourceUniqueName": { "type": "string", "maxLength": 255 }, "targetStatus": { "type": "string" }, "rootItem": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "QuoteType": { "title": "QuoteType", "description": "The type code is QTT", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "configuration": { "type": "object", "additionalProperties": { "type": "string" } }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "headerFormulaName": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "defaultTypeDeleteNotAllowedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "editNotAllowedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS" ] }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "workflowFormulaName": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "QuoteLineItem": { "title": "QuoteLineItem", "description": "The type code is QLI.", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array" }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "dirty": { "type": "boolean" }, "typedId": { "type": "string" }, "treeLabel": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "lineId": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "priceRecordId": { "type": "integer" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "folder": { "type": "boolean" }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "sku": { "type": "string", "maxLength": 255 }, "containsProductImage": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "QuoteTypeAttributeMeta": { "title": "QuoteTypeAttributeMeta", "description": "The type code is QTTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Role": { "title": "Role", "description": "The type code is R", "type": "object", "properties": { "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "module": { "type": "string", "maxLength": 255, "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS" ] }, "label": { "type": "string" }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementTemplate": { "title": "RebateAgreementTemplate", "description": "The type code is RAT", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementTemplateAttributeMeta": { "title": "RebateAgreementTemplateAttributeMeta", "description": "The type code is RATM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreement": { "title": "RebateAgreement", "description": "The type code is RBA.", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "object" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "seller": { "type": "object" }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "headerText": { "type": "string" }, "successfulCalculationMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "CUSTOM_FORM_UNDELETABLE_STATUS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED" ] }, "endDate": { "type": "string", "format": "date-time" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "object" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "object" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "object" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "object" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "readOnlyLineItemClass": { "type": "string" }, "serverMessagesExtended": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "message": { "type": "string" } } } }, "externalRef": { "type": "string", "maxLength": 255 }, "payoutDate": { "type": "string", "format": "date-time" }, "deniedByName": { "type": "string" }, "lineItems": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "clicId": { "type": "integer" }, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "items": { "type": "object" } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string" }, "parentId": { "type": "string" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "label": { "type": "string" }, "containsProductImage": { "type": "boolean" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "object" } } } }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "payoutDate": { "type": "string", "format": "date-time" }, "calculationBaseJson": { "type": "string" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "object" } }, "dateDimFieldName": { "type": "string" } } }, "simulationType": { "type": "string" }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "rebateType": { "type": "string" }, "rebateTypeLabel": { "type": "string" } } } }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "approvedByName": { "type": "string" }, "creationWorkflowCurrentStep": { "type": "integer" }, "rootUniqueName": { "type": "string" }, "originUniqueName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "customerGroup": { "type": "object" }, "ioMeta": { "type": "string" }, "originDeleted": { "type": "boolean" }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "serverMessages": { "type": "array", "items": { "type": "string" } }, "creationWorkflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "INPROGRESS", "FINISHED" ] }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "conditionTypeClass": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "nodeId": { "type": "integer" }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "lastUpdateByName": { "type": "string", "maxLength": 255 }, "originClicId": { "type": "integer" }, "renderInfo": { "type": "object", "additionalProperties": { "type": "object" } }, "signature": { "type": "object", "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string", "enum": [ "sent", "delivered", "signed", "completed", "declined", "voided", "processing", "error", "cancelling" ] }, "sentDateTime": { "type": "string" }, "statusChangedDateTime": { "type": "string" }, "customerName": { "type": "string" }, "customerUserOrEmail": { "type": "string" }, "sender": { "type": "integer" }, "senderName": { "type": "string" }, "templateName": { "type": "string" }, "note": { "type": "string" }, "voidedReason": { "type": "string" }, "error": { "type": "string" }, "history": { "type": "array", "items": { "type": "object" } } } }, "rebateRecordSetId": { "type": "integer" }, "creationWorkflowStepCount": { "type": "integer" }, "sellerName": { "type": "string" }, "creationWorkflowStepLabel": { "type": "string", "maxLength": 255 }, "formulaElementGroupReadOnly": { "type": "string" }, "submittedByName": { "type": "string", "maxLength": 255 }, "formulaElementGroup": { "type": "string" }, "rebateAgreementStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "OPEN", "CLOSED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "additionalInfo4": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "refreshInputs": { "type": "boolean" }, "additionalInfo2": { "type": "number" }, "additionalInfo1": { "type": "number" }, "numberOfAttachments": { "type": "integer" }, "originLabel": { "type": "string" }, "simulationType": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "nextRevUNs": { "type": "array", "items": { "type": "string" } }, "rebateRecordSetLabel": { "type": "string", "maxLength": 255 }, "simulationSet": { "type": "string", "maxLength": 255 }, "productGroup": { "type": "object" }, "createdBy": { "type": "integer" }, "calculationWithErrorsMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "PGI_OFNONEXISTENTSKU_SOFTDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "CUSTOM_FORM_UNDELETABLE_STATUS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED" ] }, "approvalRequiredEmailAttachmentsJson": { "type": "string" }, "viewState": { "type": "object", "properties": { "gridViewState": { "type": "string" }, "openFolders": { "type": "array", "items": { "type": "string" } }, "selectedNodes": { "type": "array", "items": { "type": "string" } } } }, "prevRev": { "type": "string" }, "calculationStatus": { "type": "integer" }, "supersededBy": { "type": "string" }, "headerRebateType": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementAttributeMeta": { "title": "RebateAgreementAttributeMeta", "description": "The type code is RBAAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementLineItem": { "title": "RebateAgreementLineItem", "description": "The type code is RBALI", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "typedId": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "payoutDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "treeLabel": { "type": "string" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "lineId": { "type": "string", "maxLength": 255 }, "simulationType": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "rebateTypeLabel": { "type": "string" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "rebateType": { "type": "string" }, "folder": { "type": "boolean" }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementReadOnlyLineItem": { "title": "RebateAgreementReadOnlyLineItem", "description": "The type code is RBAROLI", "type": "object", "properties": { "outputs": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "typedId": { "type": "string" }, "calculationBaseJson": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "payoutDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "dirty": { "type": "boolean" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "treeLabel": { "type": "string" }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "lineId": { "type": "string", "maxLength": 255 }, "simulationType": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "clicId": { "type": "integer" }, "rebateTypeLabel": { "type": "string" }, "version": { "type": "integer" }, "parentId": { "type": "string", "maxLength": 255 }, "rebateType": { "type": "string" }, "folder": { "type": "boolean" }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "editabilityStatus": { "type": "integer" }, "containsProductImage": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateAgreementTree": { "title": "RebateAgreementTree", "description": "The type code is RBAT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateType": { "title": "RebateType", "description": "The type code is RBT", "type": "object", "properties": { "formulaName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "attribute19": { "type": "string", "maxLength": 255 }, "attribute18": { "type": "string", "maxLength": 255 }, "attribute17": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute16": { "type": "string", "maxLength": 255 }, "attribute15": { "type": "string", "maxLength": 255 }, "attribute25": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "maxLength": 255 }, "attribute22": { "type": "string", "maxLength": 255 }, "attribute21": { "type": "string", "maxLength": 255 }, "attribute20": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "waterfallElement": { "type": "string", "maxLength": 255 }, "attribute29": { "type": "string", "maxLength": 255 }, "attribute28": { "type": "string", "maxLength": 255 }, "attribute27": { "type": "string", "maxLength": 255 }, "attribute26": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "attribute9": { "type": "string", "maxLength": 255 }, "attribute8": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "attribute5": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "attribute4": { "type": "string", "maxLength": 255 }, "attribute7": { "type": "string", "maxLength": 255 }, "attribute6": { "type": "string", "maxLength": 255 }, "attribute1": { "type": "string", "maxLength": 255 }, "attribute14": { "type": "string", "maxLength": 255 }, "attribute13": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "maxLength": 255 }, "attribute12": { "type": "string", "maxLength": 255 }, "attribute2": { "type": "string", "maxLength": 255 }, "attribute11": { "type": "string", "maxLength": 255 }, "attribute10": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "maxLength": 255 }, "lastUpdateBy": { "type": "integer" } } }, "RebateRecordGroup": { "title": "RebateRecordGroup", "description": "The type code is RRG.", "type": "object", "properties": { "typedId": { "type": "string" }, "endDate": { "type": "string", "format": "date" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "agreementStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "OPEN", "CLOSED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "payoutDate": { "type": "string", "format": "date" }, "attribute83": { "maxLength": 70 }, "attribute82": { "maxLength": 70 }, "attribute81": { "maxLength": 70 }, "attribute80": { "maxLength": 70 }, "sourceIdNoRev": { "type": "string", "maxLength": 255 }, "attribute89": { "maxLength": 70 }, "attribute88": { "maxLength": 70 }, "attribute87": { "maxLength": 70 }, "attribute86": { "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "maxLength": 255 }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "nullable": true, "items": {} }, "alertMessage": { "type": "string", "nullable": true }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "nullable": true }, "suffix": { "type": "string", "nullable": true }, "resultType": { "type": "string" }, "cssProperties": { "type": "string", "nullable": true }, "userGroup": { "type": "string", "nullable": true }, "resultGroup": { "type": "string", "nullable": true }, "overrideValueOptions": { "type": "array", "nullable": true, "items": {} }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string", "nullable": true }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string", "nullable": true } } } }, "attribute85": { "maxLength": 70 }, "attribute84": { "maxLength": 70 }, "targetDate": { "type": "string", "format": "date", "nullable": true }, "allowedOverrides": { "type": "string", "maxLength": 1300, "nullable": true }, "version": { "type": "integer" }, "alerts": { "type": "string", "nullable": true }, "attribute9": { "maxLength": 70 }, "attribute94": { "maxLength": 70 }, "attribute8": { "maxLength": 70 }, "attribute93": { "maxLength": 70 }, "attribute92": { "maxLength": 70 }, "attribute91": { "maxLength": 70 }, "attribute5": { "maxLength": 70 }, "attribute90": { "maxLength": 70 }, "attribute4": { "maxLength": 70 }, "attribute7": { "maxLength": 70 }, "attribute6": { "maxLength": 70 }, "attribute1": { "maxLength": 70 }, "attribute14": { "maxLength": 70 }, "attribute13": { "maxLength": 70 }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "maxLength": 70 }, "attribute12": { "maxLength": 70 }, "attribute2": { "maxLength": 70 }, "attribute11": { "maxLength": 70 }, "attribute99": { "maxLength": 70 }, "attribute10": { "maxLength": 70 }, "attribute98": { "maxLength": 70 }, "attribute97": { "maxLength": 70 }, "startDate": { "type": "string", "format": "date" }, "attribute96": { "maxLength": 70 }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "APPROVED", "REVOKED", "INVALIDATED" ] }, "attribute95": { "maxLength": 70 }, "formulaName": { "type": "string", "maxLength": 255 }, "itemExtensions": { "type": "object", "nullable": true }, "attribute19": { "maxLength": 70 }, "attribute18": { "maxLength": 70 }, "attribute17": { "maxLength": 70 }, "attribute16": { "maxLength": 70 }, "attribute15": { "maxLength": 70 }, "calculationDate": { "type": "string", "format": "date-time" }, "manualOverrides": { "type": "string", "nullable": true }, "parentTypedId": { "type": "string", "nullable": true }, "attribute25": { "maxLength": 70 }, "submittedByName": { "type": "string", "maxLength": 255, "nullable": true }, "attribute24": { "maxLength": 70 }, "attribute23": { "maxLength": 70 }, "attribute22": { "maxLength": 70 }, "attribute21": { "maxLength": 70 }, "attribute20": { "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "approvalRequiredEmailAttachments": { "type": "array", "nullable": true, "items": {} }, "attribute29": { "maxLength": 70 }, "attribute28": { "maxLength": 70 }, "attribute27": { "maxLength": 70 }, "attribute26": { "maxLength": 70 }, "completeResultsAvailable": { "maxLength": 255 }, "submittedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DUPLICATE_BUSINESSKEY_DETAILED", "VALIDATION_DUPLICATE_LABEL_NAME_DETAILED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_ACTION_ITEM_TYPE", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_PWNED_PASSWORD_DIGEST_ERROR", "VALIDATION_PWNED_SERVICE_ERROR", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "VALIDATION_PLATFORM_MANAGER_ACCOUNT_CANNOT_BE_EDITED", "VALIDATION_TOO_MANY_ENTITIES_FOR_THE_TIME_PERIOD", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "COR_ONGOING_CALCULATION", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "RR_ONGOING_CALCULATION", "RRG_CALCULATED", "RRG_CALCULATED_WITHERRORS", "RRG_SUBMITTED", "RRG_SAVED", "RRG_ONGOING_CALCULATION", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACT_ONGOING_CALCULATION", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "ACTIONITEMTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "ACTIONITEMTYPE_EDIT_NOTALLOWED", "CUSTOM_FORM", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_CANNOT_BE_CALCULATED", "CUSTOM_FORM_CANNOT_BE_DELETED", "CUSTOM_FORM_CANNOT_CREATE_REVISION", "CUSTOM_FORM_CANNOT_CREATE_REVISION_FROM_EMBEDDED", "CUSTOM_FORM_CANNOT_SUBMIT", "CUSTOM_FORM_COPY_PREFIX", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED", "NOTIFICATION_ACTION_ITEM_ASSIGNED", "NOTIFICATION_ACTION_CHANGED_STATUS", "NOTIFICATION_ACTION_OVERDUE", "NOTIFICATION_SUBMISSION_FINISHED", "NOTIFICATION_SUBMISSION_FAILED", "CRITICAL_ALERT", "RED_ALERT", "YELLOW_ALERT", "WARNING", "EXCEPTION", "WARNING_ITEM", "WARNING_HEADER", "ERROR", "VALIDATION", "CALCULATION", "TITLE", "SUBMIT_FOR_APPROVAL" ] }, "attribute36": { "maxLength": 70 }, "attribute35": { "maxLength": 70 }, "attribute34": { "maxLength": 70 }, "attribute33": { "maxLength": 70 }, "attribute32": { "maxLength": 70 }, "attribute31": { "maxLength": 70 }, "headerRebateType": { "type": "string" }, "attribute30": { "maxLength": 70 }, "sourceId": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string", "maxLength": 255, "nullable": true }, "attribute39": { "maxLength": 70 }, "inputs": { "type": "array", "nullable": true, "items": {} }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "maxLength": 70 }, "attribute37": { "maxLength": 70 }, "serverMessagesExtended": { "type": "array", "nullable": true, "items": {} }, "deniedByName": { "type": "string", "nullable": true }, "attribute47": { "maxLength": 70 }, "attribute46": { "maxLength": 70 }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "approvedByName": { "type": "string", "nullable": true }, "attribute45": { "maxLength": 70 }, "attribute44": { "maxLength": 70 }, "locked": { "type": "boolean" }, "attribute43": { "maxLength": 70 }, "attribute42": { "maxLength": 70 }, "attribute41": { "maxLength": 70 }, "attribute40": { "maxLength": 70 }, "ongoingCalculationMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DUPLICATE_BUSINESSKEY_DETAILED", "VALIDATION_DUPLICATE_LABEL_NAME_DETAILED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_ACTION_ITEM_TYPE", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_PWNED_PASSWORD_DIGEST_ERROR", "VALIDATION_PWNED_SERVICE_ERROR", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "VALIDATION_PLATFORM_MANAGER_ACCOUNT_CANNOT_BE_EDITED", "VALIDATION_TOO_MANY_ENTITIES_FOR_THE_TIME_PERIOD", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "COR_ONGOING_CALCULATION", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "RR_ONGOING_CALCULATION", "RRG_CALCULATED", "RRG_CALCULATED_WITHERRORS", "RRG_SUBMITTED", "RRG_SAVED", "RRG_ONGOING_CALCULATION", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACT_ONGOING_CALCULATION", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "ACTIONITEMTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "ACTIONITEMTYPE_EDIT_NOTALLOWED", "CUSTOM_FORM", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_CANNOT_BE_CALCULATED", "CUSTOM_FORM_CANNOT_BE_DELETED", "CUSTOM_FORM_CANNOT_CREATE_REVISION", "CUSTOM_FORM_CANNOT_CREATE_REVISION_FROM_EMBEDDED", "CUSTOM_FORM_CANNOT_SUBMIT", "CUSTOM_FORM_COPY_PREFIX", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED", "NOTIFICATION_ACTION_ITEM_ASSIGNED", "NOTIFICATION_ACTION_CHANGED_STATUS", "NOTIFICATION_ACTION_OVERDUE", "NOTIFICATION_SUBMISSION_FINISHED", "NOTIFICATION_SUBMISSION_FAILED", "CRITICAL_ALERT", "RED_ALERT", "YELLOW_ALERT", "WARNING", "EXCEPTION", "WARNING_ITEM", "WARNING_HEADER", "ERROR", "VALIDATION", "CALCULATION", "TITLE", "SUBMIT_FOR_APPROVAL" ] }, "attribute49": { "maxLength": 70 }, "attribute48": { "maxLength": 70 }, "attribute50": { "maxLength": 70 }, "rebateType": { "type": "string" }, "attribute100": { "maxLength": 70 }, "uniqueName": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "maxLength": 70 }, "attribute57": { "maxLength": 70 }, "attribute56": { "maxLength": 70 }, "attribute55": { "maxLength": 70 }, "hasWorkflowHistory": { "type": "boolean" }, "attribute54": { "maxLength": 70 }, "attribute53": { "maxLength": 70 }, "attribute52": { "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } }, "attribute51": { "maxLength": 70 }, "lastUpdateByName": { "type": "string", "maxLength": 255, "nullable": true }, "approvalDate": { "type": "string", "format": "date-time", "nullable": true }, "attribute59": { "maxLength": 70 }, "attribute61": { "maxLength": 70 }, "attribute60": { "maxLength": 70 }, "attribute69": { "maxLength": 70 }, "attribute68": { "maxLength": 70 }, "attribute67": { "maxLength": 70 }, "calculatedWithErrorsMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DUPLICATE_BUSINESSKEY_DETAILED", "VALIDATION_DUPLICATE_LABEL_NAME_DETAILED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_ACTION_ITEM_TYPE", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_PWNED_PASSWORD_DIGEST_ERROR", "VALIDATION_PWNED_SERVICE_ERROR", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "VALIDATION_PLATFORM_MANAGER_ACCOUNT_CANNOT_BE_EDITED", "VALIDATION_TOO_MANY_ENTITIES_FOR_THE_TIME_PERIOD", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "COR_ONGOING_CALCULATION", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "RR_ONGOING_CALCULATION", "RRG_CALCULATED", "RRG_CALCULATED_WITHERRORS", "RRG_SUBMITTED", "RRG_SAVED", "RRG_ONGOING_CALCULATION", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACT_ONGOING_CALCULATION", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "ACTIONITEMTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "ACTIONITEMTYPE_EDIT_NOTALLOWED", "CUSTOM_FORM", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_CANNOT_BE_CALCULATED", "CUSTOM_FORM_CANNOT_BE_DELETED", "CUSTOM_FORM_CANNOT_CREATE_REVISION", "CUSTOM_FORM_CANNOT_CREATE_REVISION_FROM_EMBEDDED", "CUSTOM_FORM_CANNOT_SUBMIT", "CUSTOM_FORM_COPY_PREFIX", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED", "NOTIFICATION_ACTION_ITEM_ASSIGNED", "NOTIFICATION_ACTION_CHANGED_STATUS", "NOTIFICATION_ACTION_OVERDUE", "NOTIFICATION_SUBMISSION_FINISHED", "NOTIFICATION_SUBMISSION_FAILED", "CRITICAL_ALERT", "RED_ALERT", "YELLOW_ALERT", "WARNING", "EXCEPTION", "WARNING_ITEM", "WARNING_HEADER", "ERROR", "VALIDATION", "CALCULATION", "TITLE", "SUBMIT_FOR_APPROVAL" ] }, "attribute66": { "maxLength": 70 }, "attribute65": { "maxLength": 70 }, "attribute64": { "maxLength": 70 }, "attribute63": { "maxLength": 70 }, "attribute62": { "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15, "nullable": true }, "comments": { "type": "string", "maxLength": 255, "nullable": true }, "warnings": { "type": "string", "nullable": true }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "calculatedMsg": { "type": "string", "enum": [ "SUCCESS", "COMMAND_GENERAL_ERROR", "COMMAND_GENERAL_ERROR_WITH_MSG", "COMMAND_GENERAL_ERROR_CONFLICT", "COMMAND_GENERAL_ERROR_CONFLICT_FIELD", "COMMAND_NOT_FOUND", "COMMAND_CONFIG_ERROR", "COMMAND_CONTEXT_PATH_NOTFOUND", "COMMAND_NOT_AUTHORIZED", "COMMAND_INVALID_PARAMETERS", "COMMAND_FORBIDDEN_IN_K8S", "COMMAND_FORBIDDEN_IN_READONLYMODE", "COMMAND_FORM_TOO_LARGE", "OBJECT_NOT_FOUND", "LOGIN_FAILURE", "LOGIN_FAILURE_BANNED", "LOGIN_FAILURE_TFA", "LOGIN_FAILURE_INACTIVE_OR_EXPIRED", "PARTITION_UNKNOWN", "COPY_OF_PREFIX", "SIM_OF_PREFIX", "TOO_MANY_WARNINGS", "NO_NAME", "ERROR_MESSAGE", "ERROR_STATUS", "ERROR_HTTPCODE", "ERROR_ACTION", "ERROR_TIMESTAMP", "INVALID", "FORMULA_ERROR", "DEFAULT_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_NOT_FOUND", "ACTIVE_FORMULA_OF_NATURE_NOT_FOUND", "FORMULA_NOT_FOUND", "FORMULA_NOT_FOUND_FOR", "FE_SYNTAX_ERROR", "FE_UNKNOWN_SYMBOL_ERROR", "FE_WRONG_NUMBER_OF_ARGS", "FE_ILLEGAL_OPERATION", "FE_ILLEGAL_ARGUMENT", "FE_ILLEGAL_STATUS", "FE_UNDEFINED_FUNCTION", "FE_UNDEFINED_UNIT", "FE_UNDEFINED_VARIABLE", "FE_FLEXCHART_UNSUPPORTED_FEATURE", "FE_FLEXCHART_UNRECOGNIZED_OPTION", "FE_FLEXCHART_INVALID_OPTION", "FE_FLEXCHART_FORBIDDEN_OPTION", "FE_FLEXCHART_INVALID_JSON", "FE_FLEXCHART_GENERIC_ERROR", "FE_EMBEDDED_DASHBOARD_API_MALFORMED_CONF", "FE_EMBEDDED_DASHBOARD_API_FUNCTION_DOES_NOT_EXIST", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_FUNCTION_CALL", "FE_EMBEDDED_DASHBOARD_API_ILLEGAL_ARGUMENT", "FE_WARNING_FLEXCHART_UNRECOGNIZED_TEMPLATE", "FE_WARNING_ATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCT_NOTSET", "FE_WARNING_PRODUCT_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_NOTFOUND", "FE_WARNING_PRODUCTATTRIBUTE_AMIBGUOUS", "FE_WARNING_CUSTOMER_NOTSET", "FE_WARNING_CUSTOMER_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_NOTFOUND", "FE_WARNING_CUSTOMERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_NOTFOUND", "FE_WARNING_SELLERATTRIBUTE_AMIBGUOUS", "FE_WARNING_SELLER_NOTSET", "FE_WARNING_VLOOKUP_TABLE_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_NOTFOUND", "FE_WARNING_VLOOKUP_KEY_ISNULL", "FE_WARNING_VLOOKUP_AMIBGUOUS", "FE_WARNING_VLOOKUP_AMIBGUOUS_NOKEY", "FE_WARNING_CONTEXT_NOTFOUND", "FE_WARNING_CONTEXT_AMIBGUOUS", "FE_WARNING_USERENTRY_NOTFOUND", "FE_WARNING_CONFIGURATOR_NOTFOUND", "FE_WARNING_OPTION_NOTFOUND", "FE_WARNING_FUNCTIONCALL_AMIBGUOUS", "FE_WARNING_ARITHMETICEXCEPTION", "FE_WARNING_PRICELIST_ITEMNOTFOUND", "FE_INFO_DATAMARTQUERY_USINGCACHEDRESULT", "FE_WARNING_DATAMARTQUERY_INVALIDQUERY", "FE_WARNING_DATAMARTQUERY_MAXROWSEXCEEDED", "FE_WARNING_DATAMARTLOOKUP_QUERYNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_FIELDNOTFOUND", "FE_WARNING_DATAMARTLOOKUP_INVALIDFILTER", "FE_WARNING_DATAMARTLOOKUP_MAXROWSEXCEEDED", "FE_WARNING_COULD_NOT_COMBINE_ELEMENTS", "FE_WARNING_PRODUCT_EXTENSION_NAME_NOTSET", "FE_WARNING_CUSTOMER_EXTENSION_NAME_NOTSET", "FE_WARNING_PRICERECORD_NOTFOUND", "FE_WARNING_PRODUCTGROUP_NOTFOUND", "FE_WARNING_CUSTOMERGROUP_NOTFOUND", "FE_WARNING_SELLERGROUP_NOTFOUND", "FE_WARNING_ANYUSER_NOTFOUND", "FE_WARNING_MULTITIERENTRY_NOTFOUND", "FE_WARNING_DATASOURCE_NOTFOUND", "FE_WARNING_FIELD_NOTFOUND", "FE_WARNING_REBATERECORD_NOTFOUND", "FE_WARNING_CONTEXTSKUSET_NOTSETORMALFORMED", "FE_WARNING_FILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_FILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_DMFILTERBUILDERUSERENTRY_NOTFOUND", "FE_WARNING_DMFILTERBUILDERUSERENTRY_ILLEGALVALUE", "FE_WARNING_REBATE_AGREEMENT_NOTFOUND", "FE_WARNING_REBATE_AGREEMENT_ATTRIBUTE_NOTFOUND", "FE_WARNING_CLAIM_WRONG_VALIDATION_STATE", "FE_WARNING_HOOK_GENERIC_ERROR", "FE_WARNING_HOOK_GENERIC_DENIED_MESSAGE", "FE_WARNING_PARENT_NOTFOUND", "FE_WARNING_MAX_RESULTS_SIZE_EXCEEDED", "FE_WARNING_MISSING_BUSINESSKEY_VALUE", "VALIDATION_SKU_MISSING", "VALIDATION_PARTITION_USERNAME_UPDATE", "VALIDATION_PARTITION_PASSWORD_UPDATE", "VALIDATION_PARTITION_NULL", "VALIDATION_PARTITION_MISMATCH", "VALIDATION_CUSTOMERID_MISSING", "VALIDATION_SELLERID_MISSING", "VALIDATION_DUPLICATE_BUSINESSKEY", "VALIDATION_DUPLICATE_BUSINESSKEY_PARAMETERIZED", "VALIDATION_DUPLICATE_BUSINESSKEY_DETAILED", "VALIDATION_DUPLICATE_LABEL_NAME_DETAILED", "VALIDATION_DYNAMIC_TABS_DUPLICATED_CUSTOM_FORMS", "VALIDATION_DYNAMIC_TABS_STANDALONE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_UNSUPPORTED_TYPE_CUSTOM_FORM", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_CONFIG_WIZARD", "VALIDATION_DYNAMIC_TABS_NON_EXISTING_ACTION_ITEM_TYPE", "VALIDATION_DYNAMIC_TABS_MISSING_TAB", "VALIDATION_NEWER_VERSION_EXISTS", "VALIDATION_FORMULAELEMENT_EMPTYNAME", "VALIDATION_FORMULAELEMENT_INVALIDNAME", "VALIDATION_FAILED", "VALIDATION_FIELD_DUPLICATE_VALUE", "VALIDATION_FIELD_MISSING", "VALIDATION_NEITHER_FIELD_PRESENT", "VALIDATION_DEFAULT_LABEL_TRANSLATION_MISSING", "VALIDATION_FIELD_INVALID_CHARS", "VALIDATION_FIELD_INVALID", "VALIDATION_FIELD_TOO_BIG", "VALIDATION_FIELD_TOO_BIG_WITH_MSG", "VALIDATION_NUMBER_TOO_BIG", "VALIDATION_STATUS_RESTRICTED", "VALIDATION_USERGROUP_RESTRICTED", "VALIDATION_WORKFLOW_RESTRICTED", "VALIDATION_EDIT_NOT_AUTHORIZED", "VALIDATION_FETCH_NOT_AUTHORIZED", "VALIDATION_DELETE_NOT_AUTHORIZED", "VALIDATION_ADD_NOT_AUTHORIZED", "VALIDATION_INVALID_STATUS", "VALIDATION_LINKED_OBJ_NOT_SAVED", "VALIDATION_BOTH_SKU_AND_PRODUCTGROUP_PRESENTED", "VALIDATION_BOTH_CUSTOMERID_AND_CUSTOMERGROUP_PRESENTED", "VALIDATION_PLASMA_DELETE", "VALIDATION_PLASMA_MISMATCH", "VALIDATION_PLASMA_UPDATE", "VALIDATION_PWDCOMPLEXITYRULES_INVALID_PASSWORD", "VALIDATION_PWNED_PASSWORD", "VALIDATION_PWNED_PASSWORD_DIGEST_ERROR", "VALIDATION_PWNED_SERVICE_ERROR", "VALIDATION_INVALID_OLD_PASSWORD", "VALIDATION_APPLICATIONPROPERTIES_PWDCOMPLEXITYRULES_UNKNOWN", "VALIDATION_FORMULA_WITH_NAME_AND_DIFFERENT_NATURE_EXISTS", "VALIDATION_FORMULA_WORKFLOWTYPE_NOTALIGNED", "VALIDATION_DATE_CONFLICT_WITH", "VALIDATION_INVALID_ENDDATE", "VALIDATION_MISSING_DRIVERS", "VALIDATION_APPLICATIONPROPERTIES_REVISIONPATTERN_FIELD_MISSING", "VALIDATION_IMPORT_EXCEL_INVALID_HEADER", "VALIDATION_WARNING_BUSINESS_KEYS_LENGTHS_EXCEEDED", "VALIDATION_MULTIPLE_FORMULA_INHERITANCE_NOT_ALLOWED", "VALIDATION_NATURE_NOT_ALLOWED_FOR_INHERITANCE", "VALIDATION_PARENT_AND_CHILD_NATURES_DO_NOT_MATCH", "VALIDATION_PLATFORM_MANAGER_ACCOUNT_CANNOT_BE_EDITED", "VALIDATION_TOO_MANY_ENTITIES_FOR_THE_TIME_PERIOD", "PL_ALERT_PRICEDEVIATION_TOO_HIGH", "PL_WRONG_TYPE", "PL_ALREADY_APPROVED", "PL_NOTFOUND", "PL_CAN_CONVERT_TO_APPROVED", "CALC_ALREADY_FINISHED", "CALC_CANCEL_QUEUED", "CALC_SERIALIZATION_ERROR", "NO_MAPPING", "PG_ISEMPTY", "PGI_OFNONEXISTENTSKU_SKIPPED", "PGI_OFNONEXISTENTSKU_INVALIDATED", "PGI_OFNONEXISTENTSKU_HARDDELETED", "SIM_ISEMPTY", "SIM_BASEPL_INVALID", "NOT_ENOUGH_LICENSES", "CANNOT_EXPAND_SCOPE_BUSINESSROLE", "ACCESS_DENIED", "DM_DEPLOYMENT_IN_PROGRESS", "DM_OBJECT_ISLOCKED", "DM_DEFAULT_DS_CREATION_FAILED", "DM_SCHEMA_INTEGRITY_ERROR", "DM_ACTION_NOTALLOWED", "DM_VALIDATION_MAXROWS_EXCEEDED", "DM_VALIDATION_HEADER_INVALIDFIELD", "DM_VALIDATION_FIELD_UNKNOWN", "DM_VALIDATION_KEYFIELD_MISSING", "DM_VALIDATION_FIELD_MISSING", "DM_VALIDATION_ROW_INVALIDFORMAT", "DM_VALIDATION_ROW_FIELDMISMATCH", "DM_VALIDATION_FIELD_INVALIDVALUE", "DM_VALIDATION_INVALID", "DM_VALIDATION_DM_FIELD_AMBIGIOUS", "DM_VALIDATION_SCHEMA_FIELDCONFLICT", "DM_VALIDATION_SCHEMA_AMBIGUOUSFIELDTYPE", "DM_VALIDATION_SCHEMA_CIRCULARDEPENDENCY", "DM_VALIDATION_DS_INVALID", "DM_VALIDATION_DM_INVALID", "DM_VALIDATION_FC_DEPENDENTONINVALIDFC", "DM_VALIDATION_FC_INVALIDFIELDS", "DM_VALIDATION_FC_INVALIDCALCULATEDFIELDS", "DM_VALIDATION_FC_INVALIDNAME", "DM_VALIDATION_FC_DUPLICATEFIELDS", "DM_VALIDATION_DS_NOKEY", "DM_VALIDATION_DS_AMBIGUOUSCCY", "DM_VALIDATION_DS_AMBIGUOUSUOM", "DM_VALIDATION_DS_MISSINGKEYFIELDS", "DM_VALIDATION_DM_NOKEY", "DM_VALIDATION_DM_SOURCE_MISSING", "DM_VALIDATION_DM_FIELD_UNKNOWN", "DM_VALIDATION_DM_INVALIDFIELDS", "DM_VALIDATION_DEPENDENCIES_MISSING", "DM_VALIDATION_SOURCE_NOTACCESSIBLE", "DM_VALIDATION_SOURCE_FIELD_UNKNOWN", "DM_VALIDATION_SOURCE_FIELD_MISSING", "DM_VALIDATION_SYSTEM_GENERATED_DATASOURCE", "DM_VALIDATION_CFS_KEYNOTALLOWED", "DM_VALIDATION_KEYFIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDNAME", "DM_VALIDATION_FIELD_INVALIDTYPE", "DM_VALIDATION_FIELD_INVALIDEXPRESSION", "DM_VALIDATION_QUERY_SOURCE_MISSING", "DM_VALIDATION_QUERY_NOTQUERYABLE", "DM_VALIDATION_QUERY_INVALIDCCYCODE", "DM_VALIDATION_QUERY_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALID", "DM_VALIDATION_QUERY_PROJ_INVALIDTYPE", "DM_VALIDATION_QUERY_PROJ_INVALIDCALCMODE", "DM_VALIDATION_QUERY_PROJ_CANNOTROLLUP", "DM_VALIDATION_QUERY_PROJ_CANNOTGENSTATPROJ", "DM_VALIDATION_QUERY_PROJ_INVALIDDEFAULT", "DM_VALIDATION_QUERY_EXPR_UNKNOWNIDENTIFIER", "DM_VALIDATION_QUERY_ROWLIMIT_INVALID", "DM_VALIDATION_QUERY_PIVOTCOLUMNLIMIT", "DM_VALIDATION_QUERY_FILTER_INVALID", "DM_VALIDATION_QUERY_MISSING_SQL", "DM_VALIDATION_DUPLICATE", "DM_VALIDATION_AMBIGUOUS", "DM_LABEL_CALENDAR", "DM_LABEL_TIMEDIM_DAY", "DM_LABEL_TIMEDIM_WEEK", "DM_LABEL_TIMEDIM_MONTH", "DM_LABEL_TIMEDIM_QUARTER", "DM_LABEL_TIMEDIM_YEAR", "DM_LABEL_DEFAULTFEED2DSFORMULA", "DM_DATASOURCES", "DM_VALIDATION_PARTITIONING_KEY_MORE_THAN_ONE", "DM_VALIDATION_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_FIELD_PARTITIONING_KEY_HAS_TO_BE_DATE", "DM_VALIDATION_PARTITIONING_NO_EFFECT_ON_EXISTING", "DM_QUERY_TIMEOUT", "JST_CANNOT_START", "IMPORTFILE_VALIDATION_ERROR_DATASOURCE", "IMPORTFILE_VALIDATION_ERROR_LIST", "IMPORTFILE_VALIDATION_ERROR_READONLY", "IMPORTFILE_VALIDATION_ERROR_REQUIRED", "IMPORTFILE_VALIDATION_ERROR_START", "IMPORTFILE_VALIDATION_ERROR_FIELDTYPE", "IMPORTFILE_VALIDATION_ERROR_FILTER", "IMPORTFILE_VALIDATION_ERROR_HEADER", "MODEL_MODELTYPE_NOT_FOUND", "MODEL_CALCSTEP_NOT_FOUND", "MODEL_NATURE_NOT_FOUND", "MODEL_TYPE_DEFINITION_INVALID", "MODEL_NOT_SPECIFIED", "MODEL_RECORD_NOT_SPECIFIED", "ROLLUP_INVALID", "QUOTE_USERGROUP_RESTRICTED", "QUOTE_CALCULATED", "QUOTE_CALCULATED_WITHERRORS", "QUOTE_SUBMITTED", "QUOTE_SAVED", "QUOTE_SUPERSEDEDBY", "QUOTE_PRODUCTSNOTADDED", "QUOTE_ALREADY_EXPIRED", "QUOTE_TESTRESULTELEMENTNAME", "QUOTE_LINEITEMS_DOTOMATCHQPF", "QUOTE_QPF_COMPUTATION_FAILED", "QUOTE_COULD_NOT_CONVERT_TO_DEAL", "QUOTE_NON_EXISTENT_SKUS", "QUOTE_WASDELETEDONSERVER", "QUOTETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "QUOTETYPE_DEFAULTTYPE_EDIT_NOTALLOWED", "QUOTETYPE_EDIT_NOTALLOWED", "QUOTETYPE_MISSING", "HEADER_PREPHASE_ELEMENTPOSTFIX", "HEADER_POSTPHASE_ELEMENTPOSTFIX", "RBA_USERGROUP_RESTRICTED", "RBA_CALCULATED", "RBA_CALCULATED_WITHERRORS", "RBA_SUBMITTED", "RBA_SAVED", "RBA_SUPERSEDEDBY", "RBA_ITEMSNOTADDED", "RBA_TESTRESULTELEMENTNAME", "RBA_WASDELETEDONSERVER", "REBATETYPE_MISSING", "RBA_LINEITEMS_DONOTMATCHRBTF", "RBA_RBTF_COMPUTATION_FAILED", "RBA_HEADERREBATETYPE_MISSING", "HEADERREBATETYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "HEADERREBATETYPE_EDIT_NOTALLOWED", "HEADERREBATETYPE_MISSING", "COMPENSATION_CONDITIONTYPE_MISSING", "COMPENSATION_USERGROUP_RESTRICTED", "COMPENSATION_CALCULATED", "COMPENSATION_CALCULATED_WITHERRORS", "COMPENSATION_SUBMITTED", "COMPENSATION_SAVED", "COMPENSATION_SUPERSEDEDBY", "COMPENSATION_ITEMSNOTADDED", "COMPENSATION_TESTRESULTELEMENTNAME", "COMPENSATION_WASDELETEDONSERVER", "COMPENSATION_LINEITEMS_DONOTMATCHRBTF", "COMPENSATION_RBTF_COMPUTATION_FAILED", "COMPENSATION_COMPENSATIONHEADERTYPE_MISSING", "COMPENSATIONHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "COMPENSATIONHEADERTYPE_EDIT_NOTALLOWED", "COMPENSATIONHEADERTYPE_MISSING", "COR_CALCULATED", "COR_CALCULATED_WITHERRORS", "COR_SUBMITTED", "COR_SAVED", "COR_ONGOING_CALCULATION", "RR_CALCULATED", "RR_CALCULATED_WITHERRORS", "RR_SUBMITTED", "RR_SAVED", "RR_ONGOING_CALCULATION", "RRG_CALCULATED", "RRG_CALCULATED_WITHERRORS", "RRG_SUBMITTED", "RRG_SAVED", "RRG_ONGOING_CALCULATION", "MR_CALCULATED", "MR_CALCULATED_WITHERRORS", "MR_SUBMITTED", "MR_SAVED", "MR_WARNING_NOTALLRECORDSSUBMITTED", "CONTRACT_SAVED", "CONTRACT_SUPERSEDEDBY", "CONTRACT_CALCULATED", "CONTRACT_CALCULATED_WITHERRORS", "CONTRACT_SUBMITTED", "CONTRACT_ITEMSNOTADDED", "CONTRACT_INVALID_CUSTOMER_GROUP", "CONTRACT_INVALID_CUSTOMER_GROUP_FOR_LINE", "CONTRACT_INVALID_PRODUCT_GROUP", "CONTRACT_INVALID_PRODUCT_GROUP_FOR_LINE", "CONTRACT_INVALID_SELLER_REFERENCE", "CONTRACT_INVALID_SELLER_REFERENCE_FOR_LINE", "CONTRACT_TESTRESULTELEMENTNAME", "CONTRACT_LINEITEMS_DONOTMATCHCTTF", "CONTRACT_CTTF_COMPUTATION_FAILED", "CONTRACT_WASDELETEDONSERVER", "CONTRACTTERMTYPE_MISSING", "CONTRACT_ONGOING_CALCULATION", "CONTRACTHEADERTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "CONTRACTHEADERTYPE_EDIT_NOTALLOWED", "CONTRACTHEADERTYPE_MISSING", "ACTIONITEMTYPE_DEFAULTTYPE_DELETE_NOTALLOWED", "ACTIONITEMTYPE_EDIT_NOTALLOWED", "CUSTOM_FORM", "CUSTOM_FORM_CALCULATED", "CUSTOM_FORM_CALCULATED_WITH_ERRORS", "CUSTOM_FORM_CANNOT_BE_CALCULATED", "CUSTOM_FORM_CANNOT_BE_DELETED", "CUSTOM_FORM_CANNOT_CREATE_REVISION", "CUSTOM_FORM_CANNOT_CREATE_REVISION_FROM_EMBEDDED", "CUSTOM_FORM_CANNOT_SUBMIT", "CUSTOM_FORM_COPY_PREFIX", "CUSTOM_FORM_MISSING_REQUIRED_INPUTS", "VIEW_EDIT_RESTRICTED_BY_FORMULA_ENTITLEMENT_FILTER", "WORKFLOW_PREVIEW_NO_APPROVAL_REQUIRED", "WORKFLOW_ERROR", "WORKFLOW_ONBEHALF_MESSAGE", "WORKFLOW_USERGROUP_INFORMATION_ERROR", "WORKFLOW_INVALID_EMAILS_IN_WATCHER_STEP", "WORKFLOW_MAIL_ERROR_USER_MAIL_NOT_DEFINED", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_ONBEHALF", "WORKFLOW_STEP_USER_CANNOT_EXECUTE_STEP_SUBMITTER", "WORKFLOW_STEP_WRONG_STEP_BEING_EXECUTED", "WORKFLOW_USER_INFORMATION_ERROR", "WORKFLOW_ATTACHMENT_NOT_FOUND_ERROR", "WORKFLOW_MANDATORY_COMMENT_MISSING_ERROR", "WORKFLOW_MANDATORY_COMMENT_IMPOSSIBLE_ERROR", "WORKFLOW_MAX_CUMULATIVE_SIZE_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_MULTIPLE_ATTACHMENTS_WITH_SAME_NAME_ERROR", "WORKFLOW_MAX_NUMBER_OF_ATTACHMENTS_EXCEEDED_ERROR", "WORKFLOW_NOT_FOUND", "WORKFLOW_STEPEXECUTIONSTATUS_INITIALIZED", "WORKFLOW_STEPEXECUTIONSTATUS_PREEXECUTED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDDENIED", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDWITHDRAWN", "WORKFLOW_STEPEXECUTIONSTATUS_EXECUTEDAPPROVED", "WORKFLOW_STEP_NON_ALLOWED_DENIAL_REASON", "WORKFLOW_STEP_USER_CANNOT_ADD_STEP", "WORKFLOW_STEP_USER_CANNOT_APPROVE_MORE_THAN_ONCE", "WORKFLOW_APPROVERS", "WORKFLOW_DELEGATION_COMBINED", "WORKFLOW_DELEGATION_DELEGATED", "WORKFLOW_DELEGATION_NONE", "WORKFLOW_USER_USERGROUP_NOT_DEFINED_ERROR", "WORKFLOW_USER_USERGROUP_BOTH_DEFINED_ERROR", "SUBMIT_NOT_ALLOWED", "PREVIEW_NOT_ALLOWED", "REVOKE_NOT_ALLOWED", "PO_NOT_ENABLED", "PO_OPTIMIZER_NOT_ENABLED", "CALCULATIONFLOW_EDITING_OF_DEPLOYEDFLOW_NOT_ALLOWED", "WORKFLOW_STEPEXECUTIONSTATUS_ALREADYSATISFIED", "DCR_DUPLICATE_KEY", "BINARY_RESP_ERR_ATTACHMENT_CONTENT", "ACTION_NOT_ALLOWED", "COMMON_ERROR", "PRICELISTTYPE_EDIT_NOTALLOWED", "SIGNATURE_ABORTED", "DOCX_CONVERSION_NOT_AVAILABLE", "DOCX_CONVERSION_FAILED", "RECIPIENTS", "NOTIFICATION_DOWNLOAD_READY_TITLE", "NOTIFICATION_DOWNLOAD_READY_MSG", "NOTIFICATION_CLIC_MESSAGE_TITLE", "NOTIFICATION_CLIC_MESSAGE_MSG", "NOTIFICATION_CALCULATION_END_MSG", "NOTIFICATION_CALCULATION_END_TITLE_CANCELLED", "NOTIFICATION_CALCULATION_END_TITLE_FINISHED", "NOTIFICATION_CALCULATION_END_TITLE_FAILED", "NOTIFICATION_ACTION_ITEM_ASSIGNED", "NOTIFICATION_ACTION_CHANGED_STATUS", "NOTIFICATION_ACTION_OVERDUE", "NOTIFICATION_SUBMISSION_FINISHED", "NOTIFICATION_SUBMISSION_FAILED", "CRITICAL_ALERT", "RED_ALERT", "YELLOW_ALERT", "WARNING", "EXCEPTION", "WARNING_ITEM", "WARNING_HEADER", "ERROR", "VALIDATION", "CALCULATION", "TITLE", "SUBMIT_FOR_APPROVAL" ] }, "attribute72": { "maxLength": 70 }, "attribute71": { "maxLength": 70 }, "attribute70": { "maxLength": 70 }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "attribute79": { "maxLength": 70 }, "attribute78": { "maxLength": 70 }, "attribute77": { "maxLength": 70 }, "attribute76": { "maxLength": 70 }, "attribute75": { "maxLength": 70 }, "attribute74": { "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "maxLength": 70 } } }, "RebateTypeAttributeMeta": { "title": "RebateTypeAttributeMeta", "description": "The type code is RBTAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateRecord": { "title": "RebateRecord", "description": "The type code is RR", "type": "object", "properties": { "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "endDate": { "type": "string", "format": "date-time" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "agreementStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "APPROVED", "OPEN", "CLOSED", "REVOKED", "SUPERSEDED", "INVALIDATED" ] }, "intgStatus": { "type": "string", "maxLength": 255 }, "payoutDate": { "type": "string", "format": "date-time" }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "intgStatusDetails": { "type": "string", "maxLength": 255 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "sourceIdNoRev": { "type": "string" }, "rank": { "type": "integer" }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "agreementTerms": { "type": "object", "additionalProperties": { "type": "string" } }, "targetDate": { "type": "string", "format": "date-time" }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "messages": { "type": "array", "items": { "type": "string" } }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "startDate": { "type": "string", "format": "date-time" }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "APPROVED", "REVOKED", "INVALIDATED" ] }, "attribute95": { "maxLength": 70 }, "formulaName": { "type": "string", "maxLength": 255 }, "itemExtensions": { "type": "string" }, "attribute19": { "maxLength": 70 }, "attribute18": { "maxLength": 70 }, "attribute17": { "maxLength": 70 }, "rebateRecordSetId": { "type": "integer" }, "attribute16": { "maxLength": 70 }, "attribute15": { "maxLength": 70 }, "sellerName": { "type": "string" }, "manual": { "type": "boolean" }, "calculationDate": { "type": "string", "format": "date-time" }, "manualOverrides": { "type": "string" }, "parentTypedId": { "type": "string" }, "calculationBaseAsAdvancedFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "submittedByName": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "items": { "type": "object" } }, "includedSellerReferences": { "type": "array", "items": { "type": "object" } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "single": { "type": "boolean" } } } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "string" } }, "dateDimFieldName": { "type": "string" } } }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "string", "nullable": true } }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "lineId": { "type": "string", "maxLength": 255 }, "completeResultsAvailable": { "type": "string", "nullable": true, "maxLength": 1 }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "headerRebateType": { "type": "string" }, "intgStatusErpReference": { "type": "string", "maxLength": 255 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "sourceId": { "type": "string", "maxLength": 255 }, "seller": { "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": "string" } } }, "key2": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "deniedByName": { "type": "string" }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "approvedByName": { "type": "string" }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "agreementInputs": { "type": "array", "items": { "type": "object" } }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string" }, "customerFieldName": { "type": "string" }, "customerFieldLabel": { "type": "string" }, "customerFieldValue": { "type": "string" }, "customerFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "rebateType": { "type": "string" }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "uniqueName": { "type": "string", "maxLength": 255 }, "calculatedResultPrice": { "type": "number" }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "productFilterString": { "type": "string" }, "hasWorkflowHistory": { "type": "boolean" }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationBaseJson": { "type": "string" }, "approvalDate": { "type": "string", "format": "date-time" }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "description": { "type": "string" }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "customerFilterString": { "type": "string" }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "agreementInputsAsMap": { "type": "object", "additionalProperties": { "type": "object" } }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "rebateRecordSetLabel": { "type": "string", "maxLength": 255 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "productGroup": { "type": "object", "properties": { "label": { "type": "string" }, "productFieldName": { "type": "string" }, "productFieldLabel": { "type": "string" }, "productFieldValue": { "type": "string" }, "productFilterCriteria": { "type": "object", "additionalProperties": { "type": "string" } } } }, "createdBy": { "type": "integer" }, "calculationStatus": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "RebateRecordAttributeMeta": { "title": "RebateRecordAttributeMeta", "description": "The type code is RRAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "rebateRecordSetId": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "RebateRecordSet": { "title": "RebateRecordSet", "description": "The type code is RRS", "type": "object", "properties": { "updateDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "calculationMessages": { "type": "string" }, "updatedBy": { "type": "integer" }, "targetDate": { "type": "string", "format": "date-time" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "writeOnlyChangedItems": { "type": "boolean" }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "id": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "RebateRecordSetCalculation": { "title": "RebateRecordSetCalculation", "description": "The type code is RRSC.", "type": "object", "properties": { "typedId": { "type": "string" }, "rebateRecordSetId": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "locale": { "type": "string", "maxLength": 255, "nullable": true }, "calculationDate": { "type": "string", "format": "date-time", "nullable": true }, "valid": { "type": "boolean" }, "sortBy": { "type": "string", "maxLength": 255, "nullable": true }, "adhocCalculation": { "type": "object", "nullable": true }, "rebateRecordSet": { "type": "object", "nullable": true, "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time", "nullable": true }, "label": { "type": "string" }, "locale": { "type": "string", "nullable": true }, "calculationMessages": { "type": "string", "nullable": true }, "numberOfItems": { "type": "integer" }, "keepManualOverrides": { "type": "boolean" }, "writeOnlyChangedItems": { "type": "boolean" }, "userGroupEdit": { "type": "string", "nullable": true }, "userGroupViewDetails": { "type": "string", "nullable": true }, "updatedBy": { "type": "integer" }, "updateDate": { "type": "string", "format": "date", "nullable": true }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] }, "calculationStartDate": { "type": "string", "nullable": true }, "calculationDate": { "type": "string", "nullable": true }, "id": { "type": "integer" } } }, "createDate": { "type": "string", "format": "date-time" }, "calculationMessages": { "type": "string", "nullable": true }, "targetDate": { "type": "string", "format": "date-time", "nullable": true }, "shouldSubmit": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "incremental": { "type": "boolean" }, "version": { "type": "integer" }, "rebateRecordSetLabel": { "type": "string", "maxLength": 255 }, "dtoFilter": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "isDefault": { "type": "boolean" }, "incCalculationDate": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "integer" }, "calculationStartDate": { "type": "string", "format": "date-time", "nullable": true }, "calculationConfig": { "type": "object", "nullable": true, "properties": { "skuField": { "type": "string" }, "targetDateField": { "type": "string" }, "simulationSet": { "type": "string" }, "formulaName": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "feederFormulaName": { "type": "string" }, "feederInputParams": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "lookupTableId": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "valueHint": { "type": "string" }, "readOnly": { "type": "boolean" }, "filter": { "type": "object", "additionalProperties": { "type": "string" } }, "parameterGroup": { "type": "string" }, "required": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "addUnknownValues": { "type": "boolean" }, "typedId": { "type": "string" }, "alwaysEditable": { "type": "boolean" }, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "additionalProperties": { "type": "string" } }, "formattingOptions": { "type": "object", "additionalProperties": { "type": "string" } }, "valueOptions": { "type": "array", "items": { "type": "string" } } } } }, "inputParams": { "type": "array", "items": { "type": "object" } }, "mappingParams": { "type": "array", "items": { "type": "object" } }, "outputElements": { "type": "array", "items": { "type": "object", "properties": { "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "formulaName": { "type": "string" }, "formulaDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "key": { "type": "boolean" }, "selected": { "type": "boolean" }, "displayedInPriceShop": { "type": "boolean" } } } }, "targetFields": { "type": "array", "items": { "type": "string" } } } }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "RefreshToken": { "title": "RefreshToken", "description": "The type code is RT", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "authToken": { "type": "string", "maxLength": 255 }, "registrationId": { "type": "string", "maxLength": 255 }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "refreshToken": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "SecurityAuditTrail": { "title": "SecurityAuditTrail", "description": "The type code is SAT", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "userName": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "targetObjectName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "clientIP": { "type": "string", "maxLength": 255 }, "action": { "type": "string" }, "details": { "type": "string" }, "targetObjectType": { "type": "string", "maxLength": 255 }, "timestamp": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "SavedChart": { "title": "SavedChart", "description": "The type code is SC", "type": "object", "properties": { "chartDefinition": { "type": "string" }, "createdByName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "visibility": { "type": "string", "maxLength": 255, "enum": [ "PRIVATE", "PUBLISHED", "PUBLIC" ] }, "externalChartDefinition": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "chartType": { "type": "string", "maxLength": 255 }, "nodeId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Scenario": { "title": "Scenario", "description": "The type code is SCN", "type": "object", "properties": { "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "numberOfItems": { "type": "integer" }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "itemExtensions": { "type": "string" }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationDate": { "type": "string", "format": "date-time" }, "manualOverrides": { "type": "string" }, "parentTypedId": { "type": "string" }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "ownerTypedId": { "type": "string", "maxLength": 255 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationStartDate": { "type": "string", "format": "date-time" }, "key2": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "calculatedResultPrice": { "type": "number" }, "name": { "type": "string", "maxLength": 255 }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "configurationJson": { "type": "string" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "ScenarioAttributeMeta": { "title": "ScenarioAttributeMeta", "description": "The type code is SCNAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "ownerTypedId": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "SavedChartTree": { "title": "SavedChartTree", "description": "The type code is SCT", "type": "object", "properties": { "typedId": { "type": "string" }, "isParent": { "type": "boolean" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "nodeId": { "type": "integer" }, "parentId": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "SimulationItemAttributeMeta": { "title": "SimulationItemAttributeMeta", "description": "The type code is SIAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "simulationId": { "type": "integer" }, "elementName": { "type": "string", "maxLength": 255 }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Simulation": { "title": "Simulation", "description": "The type code is SIM", "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "useFilterCriteria": { "type": "boolean" }, "baseCOType": { "type": "string", "maxLength": 255, "enum": [ "SIMPLE", "MATRIX" ] }, "locale": { "type": "string", "maxLength": 255 }, "calculationDate": { "type": "string", "format": "date-time" }, "writeOnlyChangedItems": { "type": "boolean" }, "basePriceGridId": { "type": "integer" }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "shotgunModeEnabled": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "calculationMessages": { "type": "string" }, "targetDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "simulationSet": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "numberOfItems": { "type": "integer" }, "baseCO": { "type": "string", "maxLength": 255 }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "basePricelistId": { "type": "integer" }, "ignoreSecKeyFiltering": { "type": "boolean" }, "keepManualOverrides": { "type": "boolean" }, "calculationStartDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "PENDING", "SCHEDULED", "PROCESSING", "SCHEDULED_DIRTY", "ERROR", "READY", "CANCELLED" ] } } }, "SimulationItem": { "title": "SimulationItem", "description": "The type code is SIMI", "type": "object", "properties": { "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "itemExtensions": { "type": "string" }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "manualOverrides": { "type": "string" }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "key2": { "type": "string" }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "calculatedResultPrice": { "type": "number" }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "simulationId": { "type": "integer" }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "Seller": { "title": "Seller", "description": "The Seller object. The type code is SL.", "type": "array", "items": { "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "sellerId": { "type": "string", "maxLength": 255, "description": "A unique ID of the seller." }, "userGroupViewDetails": { "type": "string", "maxLength": 255, "nullable": true }, "lastUpdateBy": { "type": "integer" }, "userGroupEdit": { "type": "string", "maxLength": 255, "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255, "description": "A full name of the seller, which is usually printed on documents." }, "reportsTo": { "type": "string", "maxLength": 255, "nullable": true }, "attribute19": { "type": "string", "maxLength": 255, "nullable": true }, "attribute18": { "type": "string", "maxLength": 255, "nullable": true }, "attribute17": { "type": "string", "maxLength": 255, "nullable": true }, "attribute16": { "type": "string", "maxLength": 255, "nullable": true }, "attribute15": { "type": "string", "maxLength": 255, "nullable": true }, "attribute25": { "type": "string", "maxLength": 255, "nullable": true }, "attribute24": { "type": "string", "maxLength": 255, "nullable": true }, "attribute23": { "type": "string", "maxLength": 255, "nullable": true }, "attribute22": { "type": "string", "maxLength": 255, "nullable": true }, "attribute21": { "type": "string", "maxLength": 255, "nullable": true }, "attribute20": { "type": "string", "maxLength": 255, "nullable": true }, "attribute29": { "type": "string", "maxLength": 255, "nullable": true }, "attribute28": { "type": "string", "maxLength": 255, "nullable": true }, "attribute27": { "type": "string", "maxLength": 255, "nullable": true }, "attribute26": { "type": "string", "maxLength": 255, "nullable": true }, "attribute9": { "type": "string", "maxLength": 255, "nullable": true }, "attribute8": { "type": "string", "maxLength": 255, "nullable": true }, "attribute5": { "type": "string", "maxLength": 255, "nullable": true }, "attribute4": { "type": "string", "maxLength": 255, "nullable": true }, "attribute7": { "type": "string", "maxLength": 255, "nullable": true }, "attribute6": { "type": "string", "maxLength": 255, "nullable": true }, "attribute1": { "type": "string", "maxLength": 255, "nullable": true }, "attribute14": { "type": "string", "maxLength": 255, "nullable": true }, "attribute13": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "type": "string", "maxLength": 255, "nullable": true }, "attribute12": { "type": "string", "maxLength": 255, "nullable": true }, "attribute2": { "type": "string", "maxLength": 255, "nullable": true }, "attribute11": { "type": "string", "maxLength": 255, "nullable": true }, "attribute10": { "type": "string", "maxLength": 255, "nullable": true }, "attribute30": { "type": "string", "maxLength": 255, "nullable": true } } } }, "SellerAttributeMeta": { "title": "SellerAttributeMeta", "description": "The type code is SLAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "SX10": { "title": "SX10", "description": "The Seller Extension object. The type code is SX10 (contains 10 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "sellerId": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute2": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute3": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute4": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute5": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute6": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute7": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute8": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute9": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute10": { "maxLength": 255, "nullable": true, "type": "string" } } } }, "SX20": { "title": "SX20", "description": "The Seller Extension object. The type code is SX20 (contains 20 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "sellerId": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 255, "type": "string", "nullable": true }, "attribute2": { "maxLength": 255, "type": "string", "nullable": true }, "attribute3": { "maxLength": 255, "type": "string", "nullable": true }, "attribute4": { "maxLength": 255, "type": "string", "nullable": true }, "attribute5": { "maxLength": 255, "type": "string", "nullable": true }, "attribute6": { "maxLength": 255, "type": "string", "nullable": true }, "attribute7": { "maxLength": 255, "type": "string", "nullable": true }, "attribute8": { "maxLength": 255, "type": "string", "nullable": true }, "attribute9": { "maxLength": 255, "type": "string", "nullable": true }, "attribute10": { "maxLength": 255, "type": "string", "nullable": true }, "attribute11": { "maxLength": 255, "type": "string", "nullable": true }, "attribute12": { "maxLength": 255, "type": "string", "nullable": true }, "attribute13": { "maxLength": 255, "type": "string", "nullable": true }, "attribute14": { "maxLength": 255, "type": "string", "nullable": true }, "attribute15": { "maxLength": 255, "type": "string", "nullable": true }, "attribute16": { "maxLength": 255, "type": "string", "nullable": true }, "attribute17": { "maxLength": 255, "type": "string", "nullable": true }, "attribute18": { "maxLength": 255, "type": "string", "nullable": true }, "attribute19": { "maxLength": 255, "type": "string", "nullable": true }, "attribute20": { "maxLength": 255, "type": "string", "nullable": true } } } }, "SX3": { "title": "SX3", "description": "The Seller Extension object. The type code is SX3 (contains 3 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "name": { "type": "string", "maxLength": 255 }, "sellerId": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "attribute1": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "type": "string", "maxLength": 255, "nullable": true }, "attribute2": { "type": "string", "maxLength": 255, "nullable": true } } } }, "SX30": { "title": "SX30", "description": "The Seller Extension object. The type code is SX30 (contains 30 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "sellerId": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute2": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute3": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute4": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute5": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute6": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute7": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute8": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute9": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute10": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute11": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute12": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute13": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute14": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute15": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute16": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute17": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute18": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute19": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute20": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute21": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute22": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute23": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute24": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute25": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute26": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute27": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute28": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute29": { "maxLength": 255, "nullable": true, "type": "string" }, "attribute30": { "maxLength": 255, "nullable": true, "type": "string" } } } }, "SX50": { "title": "SX50", "description": "The Seller Extension object. The type code is SX50 (contains 50 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "sellerId": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute2": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute3": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute4": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute5": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute6": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute7": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute8": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute9": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute10": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute11": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute12": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute13": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute14": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute15": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute16": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute17": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute18": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute19": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute20": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute21": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute22": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute23": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute24": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute25": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute26": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute27": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute28": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute29": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute30": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute31": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute32": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute33": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute34": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute35": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute36": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute37": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute38": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute39": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute40": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute41": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute42": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute43": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute44": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute45": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute46": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute47": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute48": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute49": { "maxLength": 70, "nullable": true, "type": "string" }, "attribute50": { "maxLength": 70, "nullable": true, "type": "string" } } } }, "SX6": { "title": "SX6", "description": "The Seller Extension object. The type code is SX6 (contains 6 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "sellerId": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" }, "attribute1": { "type": "string", "maxLength": 255, "nullable": true }, "attribute2": { "type": "string", "maxLength": 255, "nullable": true }, "attribute3": { "type": "string", "maxLength": 255, "nullable": true }, "attribute4": { "type": "string", "maxLength": 255, "nullable": true }, "attribute5": { "type": "string", "maxLength": 255, "nullable": true }, "attribute6": { "type": "string", "maxLength": 255, "nullable": true } } } }, "SX8": { "title": "SX8", "description": "The Seller Extension object. The type code is SX58 (contains 8 attribute fields).", "type": "array", "items": { "type": "object", "properties": { "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "type": "string" }, "sellerId": { "maxLength": 255, "type": "string" }, "typedId": { "type": "string" }, "version": { "type": "integer" }, "attribute1": { "maxLength": 255, "type": "string", "nullable": true }, "attribute2": { "maxLength": 255, "type": "string", "nullable": true }, "attribute3": { "maxLength": 255, "type": "string", "nullable": true }, "attribute4": { "maxLength": 255, "type": "string", "nullable": true }, "attribute5": { "maxLength": 255, "type": "string", "nullable": true }, "attribute6": { "maxLength": 255, "type": "string", "nullable": true }, "attribute7": { "maxLength": 255, "type": "string", "nullable": true }, "attribute8": { "maxLength": 255, "type": "string", "nullable": true } } } }, "SellerExtensionAttributeMeta": { "title": "SellerExtensionAttributeMeta", "description": "The type code is SXAM", "type": "object", "properties": { "cssProperties": { "type": "string", "maxLength": 255 }, "labelTranslations": { "type": "string" }, "typedId": { "type": "string" }, "fieldName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "fieldValueOptions": { "type": "string" }, "description": { "type": "string", "maxLength": 1000 }, "readOnly": { "type": "boolean" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "requiredField": { "type": "boolean" }, "createdBy": { "type": "integer" }, "name": { "type": "string", "maxLength": 255 }, "entityRefTypeCode": { "type": "string", "maxLength": 255 }, "formatType": { "type": "string", "maxLength": 255, "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "fieldType": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "TFAToken": { "title": "TFAToken", "description": "The type code is TFA", "type": "object", "properties": { "typedId": { "type": "string" }, "sentToEmail": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "loginName": { "type": "string", "maxLength": 255 }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "ToDoItem": { "title": "ToDoItem", "description": "The type code is TODO", "type": "object", "properties": { "createdByName": { "type": "string", "maxLength": 255 }, "targetObject": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "assignedToName": { "type": "string", "maxLength": 255 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "version": { "type": "integer" }, "assignedTo": { "type": "integer" }, "assignedToGroup": { "type": "string", "maxLength": 255 }, "completedDate": { "type": "string", "format": "date-time" }, "targetPageState": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "targetPageComponent": { "type": "string", "maxLength": 255 }, "status": { "type": "string", "maxLength": 255, "enum": [ "OPEN", "DONE", "CANCELLED" ] }, "targetPage": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "User": { "title": "User", "description": "The type code is U", "type": "object", "properties": { "lastName": { "type": "string", "maxLength": 255 }, "lastLogin": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "firstLogin": { "type": "boolean" }, "noSession": { "type": "boolean" }, "businessRoles": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "module": { "type": "string", "enum": [ "PRICESETTING", "QUOTING", "ANALYTICS", "ADMIN", "WORKFLOW", "REBATES", "AGREEMENTSPROMOTIONS", "OPTIMIZATION", "CHANNELMANAGEMENT", "MASTERDATA", "CONFIGURATION", "DASHBOARDS" ] }, "label": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "groups": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "customerFilterCriteria": { "type": "string" }, "defaultUserGroupViewDetails": { "type": "string", "maxLength": 255 }, "loginName": { "type": "string", "maxLength": 255 }, "allRoleNames": { "type": "array", "items": { "type": "string" } }, "receiveAdminEmail": { "type": "boolean" }, "wizardDashboardName": { "type": "string", "maxLength": 255 }, "email": { "type": "string", "maxLength": 255 }, "createDate": { "type": "string", "format": "date-time" }, "additionalInfo4": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "additionalInfo2": { "type": "number" }, "additionalInfo1": { "type": "number" }, "passwordExpiry": { "type": "string" }, "allGroups": { "type": "array", "items": { "type": "object" } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string" }, "label": { "type": "string" }, "additionalInfo1": { "type": "number" }, "additionalInfo2": { "type": "number" }, "additionalInfo3": { "type": "string" }, "additionalInfo4": { "type": "string" }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" } } } }, "productFilterCriteria": { "type": "string" }, "version": { "type": "integer" }, "ssoOnly": { "type": "boolean" }, "firstName": { "type": "string", "maxLength": 255 }, "defaultUserGroupEdit": { "type": "string", "maxLength": 255 }, "emailLocale": { "type": "string", "maxLength": 255 }, "workflowEmailingActivated": { "type": "boolean" }, "createdBy": { "type": "integer" }, "roleNames": { "type": "array", "items": { "type": "string" } }, "requireTFA": { "type": "boolean" }, "activated": { "type": "boolean" }, "lastUpdateBy": { "type": "integer" }, "extendedData": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserGroup": { "title": "UserGroup", "description": "The type code is UG", "type": "object", "properties": { "additionalInfo4": { "type": "string", "maxLength": 255 }, "additionalInfo3": { "type": "string", "maxLength": 255 }, "additionalInfo2": { "type": "number" }, "typedId": { "type": "string" }, "uniqueName": { "type": "string", "maxLength": 255 }, "additionalInfo1": { "type": "number" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "UploadStatus": { "title": "UploadStatus", "description": "The type code is US", "type": "object", "properties": { "owner": { "type": "string", "maxLength": 255 }, "totalBytesRead": { "type": "integer" }, "typedId": { "type": "string" }, "data": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "percentage": { "type": "integer" }, "contentLength": { "type": "integer" }, "version": { "type": "integer" }, "status": { "type": "string", "maxLength": 255, "enum": [ "STARTED", "DONE", "INPROGRESS", "ERROR", "CANCELLED", "POSTPROCESSING_DONE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "Workflow": { "title": "Workflow", "description": "The type code is W", "type": "object", "properties": { "typedId": { "type": "string" }, "code": { "type": "string", "maxLength": 255 }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "storesOnlyHeaderOfApprovableState": { "type": "boolean" }, "expandedActiveUsers": { "type": "string" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "notificationSent": { "type": "string", "format": "date-time" }, "approvableTypedId": { "type": "string", "maxLength": 255 }, "currentStepId": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "approvableUniqueName": { "type": "string", "maxLength": 255 }, "approvableParentTypedId": { "type": "string", "maxLength": 255 }, "delegation": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "WorkflowDelegation": { "title": "WorkflowDelegation", "description": "The type code is WD", "type": "object", "properties": { "note": { "type": "string", "maxLength": 255 }, "createdByAdmin": { "type": "boolean" }, "typedId": { "type": "string" }, "endDate": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "sourceUser": { "type": "string", "maxLength": 255 }, "targetUserId": { "type": "integer" }, "label": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "uniqueName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "sourceUserId": { "type": "integer" }, "targetUser": { "type": "string", "maxLength": 255 }, "startDate": { "type": "string" }, "status": { "type": "string", "maxLength": 255, "enum": [ "INITIALIZED", "ACTIVATED", "ENDDATED" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "WorkflowFormula": { "title": "WorkflowFormula", "description": "The type code is WF", "type": "object", "properties": { "lastUpdateByName": { "type": "string", "maxLength": 255 }, "createdByName": { "type": "string" }, "typedId": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "label": { "type": "string", "maxLength": 255 }, "formulaNature": { "type": "string", "maxLength": 255 }, "version": { "type": "integer" }, "simulationSet": { "type": "string", "maxLength": 255 }, "uniqueName": { "type": "string", "maxLength": 255 }, "formulaType": { "type": "string", "enum": [ "PRICING", "WORKFLOW", "LIBRARY" ] }, "createdBy": { "type": "integer" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "integer" }, "typedId": { "type": "string" }, "elementName": { "type": "string" }, "elementLabel": { "type": "string" }, "elementDescription": { "type": "string" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "conditionElementName": { "type": "string" }, "hideWarnings": { "type": "boolean" }, "excludeFromExport": { "type": "boolean" }, "protectedExpression": { "type": "boolean" }, "elementTimeout": { "type": "integer" }, "combinationType": { "type": "string", "enum": [ "ADD", "SUBTRACT", "RESULT", "INFO", "FUNCTION", "BRICK", "PYTHON" ] }, "createDate": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string" }, "lastUpdateBy": { "type": "integer" }, "formulaExpression": { "type": "string" } } } }, "userGroupEdit": { "type": "string", "maxLength": 255 }, "userGroupViewDetails": { "type": "string", "maxLength": 255 }, "workflowType": { "type": "string", "maxLength": 255 }, "validAfter": { "type": "string", "format": "date-time" }, "status": { "type": "string", "maxLength": 255, "enum": [ "ACTIVE", "SIMULATIONONLY", "INACTIVE" ] }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "WorkflowFormulaElement": { "title": "WorkflowFormulaElement", "description": "The type code is WFE", "type": "object", "properties": { "conditionElementName": { "type": "string", "maxLength": 255 }, "typedId": { "type": "string" }, "formulaExpression": { "type": "string" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "elementGroups": { "type": "array", "items": { "type": "string" } }, "protectedExpression": { "type": "boolean" }, "hideWarnings": { "type": "boolean" }, "elementTimeout": { "type": "integer" }, "version": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "elementName": { "type": "string", "maxLength": 255 }, "createdBy": { "type": "integer" }, "elementLabel": { "type": "string", "maxLength": 255 }, "combinationType": { "type": "string", "enum": [ "ADD", "SUBTRACT", "RESULT", "INFO", "FUNCTION", "BRICK", "PYTHON" ] }, "elementDescription": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "MatrixPriceGridItem": { "title": "MatrixPriceGridItem", "description": "The type code is XPGI", "type": "object", "properties": { "denialDate": { "type": "string", "format": "date-time" }, "typedId": { "type": "string" }, "resultPrice": { "type": "number" }, "workflowStatus": { "type": "string", "maxLength": 255, "enum": [ "DRAFT", "SUBMITTED", "DENIED", "APPROVED", "NO_APPROVAL_REQUIRED", "WITHDRAWN", "INVALIDATED" ] }, "activePriceDate": { "type": "string", "format": "date-time" }, "priceChangePct": { "type": "number" }, "attribute83": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute82": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute81": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute80": { "type": "string", "nullable": true, "maxLength": 70 }, "denialReason": { "type": "string", "maxLength": 255 }, "attribute89": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute88": { "type": "string", "nullable": true, "maxLength": 70 }, "sku": { "type": "string", "maxLength": 255 }, "attribute87": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute86": { "type": "string", "nullable": true, "maxLength": 70 }, "calculationResults": { "type": "array", "items": { "type": "object", "properties": { "resultName": { "type": "string" }, "resultLabel": { "type": "string" }, "result": { "type": "string" }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "string" } }, "alertMessage": { "type": "string" }, "alertType": { "type": "string", "enum": [ "CRITICAL", "RED", "YELLOW" ] }, "displayOptions": { "type": "integer" }, "formatType": { "type": "string", "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ] }, "suffix": { "type": "string" }, "resultType": { "type": "string" }, "cssProperties": { "type": "string" }, "userGroup": { "type": "string" }, "resultGroup": { "type": "string" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": { "type": "string" } } } }, "attribute85": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChangePct_ActivePrev": { "type": "number" }, "attribute84": { "type": "string", "nullable": true, "maxLength": 70 }, "manualEditUser": { "type": "integer" }, "unitOfMeasure": { "type": "string", "maxLength": 255 }, "allowedOverrides": { "type": "string", "maxLength": 1300 }, "version": { "type": "integer" }, "alerts": { "type": "string" }, "attribute9": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute94": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute8": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute93": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute92": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute91": { "type": "string", "nullable": true, "maxLength": 70 }, "manualPriceExpired": { "type": "boolean" }, "attribute5": { "description": "any type or `null`", "maxLength": 70 }, "attribute90": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute4": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute7": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute6": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute1": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute14": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute13": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute3": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute12": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute2": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute11": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute99": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute10": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute98": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute97": { "type": "string", "nullable": true, "maxLength": 70 }, "manualPriceDate": { "type": "string", "format": "date-time" }, "attribute96": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute95": { "type": "string", "nullable": true, "maxLength": 70 }, "itemExtensions": { "type": "string" }, "attribute19": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute18": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute17": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute16": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute15": { "type": "string", "nullable": true, "maxLength": 70 }, "manualOverrides": { "type": "string" }, "attribute25": { "type": "string", "nullable": true, "maxLength": 70 }, "submittedByName": { "type": "string", "maxLength": 255 }, "attribute24": { "type": "string", "nullable": true, "maxLength": 70 }, "currency": { "type": "string", "maxLength": 255 }, "attribute23": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute22": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute21": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute20": { "type": "string", "nullable": true, "maxLength": 70 }, "createDate": { "type": "string", "format": "date-time" }, "activePrice": { "type": "number" }, "approvalRequiredEmailAttachments": { "type": "array", "items": { "type": "string", "nullable": true } }, "attribute29": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute28": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute27": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute26": { "type": "string", "nullable": true, "maxLength": 70 }, "completeResultsAvailable": { "type": "string", "maxLength": 1 }, "previousPriceDate": { "type": "string", "format": "date-time" }, "attribute36": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute35": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute34": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute33": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute32": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute31": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute30": { "type": "string", "nullable": true, "maxLength": 70 }, "key2": { "type": "string", "maxLength": 255 }, "attribute39": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "attribute38": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute37": { "type": "string", "nullable": true, "maxLength": 70 }, "deniedByName": { "type": "string" }, "attribute47": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute46": { "type": "string", "nullable": true, "maxLength": 70 }, "approvedByName": { "type": "string" }, "attribute45": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute44": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute43": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute42": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute41": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute40": { "type": "string", "nullable": true, "maxLength": 70 }, "priceChange": { "type": "number" }, "attribute49": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute48": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute50": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute100": { "type": "string", "nullable": true, "maxLength": 70 }, "calculatedResultPrice": { "type": "number" }, "manualEditVersion": { "type": "integer" }, "attribute58": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute57": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute56": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute55": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute54": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute53": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute52": { "type": "string", "nullable": true, "maxLength": 70 }, "allCalculationResults": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "attribute51": { "type": "string", "nullable": true, "maxLength": 70 }, "approvalDate": { "type": "string", "format": "date-time" }, "attribute59": { "type": "string", "nullable": true, "maxLength": 70 }, "submitDate": { "type": "string", "format": "date-time" }, "attribute61": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute60": { "type": "string", "nullable": true, "maxLength": 70 }, "previousPrice": { "type": "number" }, "attribute69": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute68": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute67": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute66": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute65": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute64": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute63": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute62": { "type": "string", "nullable": true, "maxLength": 70 }, "workStatus": { "type": "string", "maxLength": 15 }, "manualResultPrice": { "type": "number" }, "comments": { "type": "string", "maxLength": 255 }, "warnings": { "type": "string" }, "approvalState": { "type": "string", "maxLength": 255, "enum": [ "NOT_APPROVED", "PARTIALLY_APPROVED", "APPROVED", "AUTO_APPROVED", "DENIED" ] }, "label": { "type": "string", "maxLength": 255 }, "attribute72": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute71": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute70": { "type": "string", "nullable": true, "maxLength": 70 }, "createdBy": { "type": "integer" }, "priceChange_ActivePrev": { "type": "number" }, "priceGridId": { "type": "integer" }, "attribute79": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute78": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute77": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute76": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute75": { "type": "string", "nullable": true, "maxLength": 70 }, "attribute74": { "type": "string", "nullable": true, "maxLength": 70 }, "lastUpdateBy": { "type": "integer" }, "attribute73": { "type": "string", "nullable": true, "maxLength": 70 } } }, "MatrixPricelistItem": { "title": "MatrixPricelistItem", "description": "The type code is XPLI", "type": "object", "properties": { "calculatedResultPrice": { "type": "number" }, "calculationResults": { "items": { "properties": { "alertMessage": { "type": "string" }, "alertType": { "enum": [ "CRITICAL", "RED", "YELLOW" ], "type": "string" }, "cssProperties": { "type": "string" }, "displayOptions": { "type": "integer" }, "excludeFromExport": { "type": "boolean" }, "formatType": { "enum": [ "NUMERIC", "NUMERIC_LONG", "MONEY", "PERCENT", "TEXT", "MONEY_EUR", "MONEY_USD", "MONEY_GBP", "MONEY_JPY", "MONEY_CHF", "MONEY_PLN", "DATETIME", "DATE", "INTEGER", "LINK", "COMPLEX", "SPARKLINE" ], "type": "string" }, "labelTranslations": { "type": "string" }, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "overrideAllowEmpty": { "type": "boolean" }, "overrideValueOptions": { "type": "array", "items": { "type": "string", "nullable": true } }, "result": { "type": "object" }, "resultDescription": { "type": "string" }, "resultGroup": { "type": "string" }, "resultLabel": { "type": "string" }, "resultName": { "type": "string" }, "resultType": { "type": "string" }, "suffix": { "type": "string" }, "userGroup": { "type": "string" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "comments": { "maxLength": 255, "type": "string" }, "completeResultsAvailable": { "maxLength": 1, "type": "string" }, "createDate": { "format": "date-time", "type": "string" }, "createdBy": { "type": "integer" }, "currency": { "maxLength": 255, "type": "string" }, "itemExtensions": { "type": "string" }, "key2": { "maxLength": 255, "type": "string" }, "label": { "maxLength": 255, "type": "string" }, "lastUpdateBy": { "type": "integer" }, "lastUpdateDate": { "format": "date-time", "type": "string" }, "listLabel": { "type": "string" }, "manualOverrides": { "type": "string" }, "manualResultPrice": { "type": "number" }, "previousPrice": { "type": "number" }, "priceChange": { "type": "number" }, "priceChangePct": { "type": "number" }, "pricelistId": { "type": "integer" }, "resultPrice": { "type": "number" }, "sku": { "maxLength": 255, "type": "string" }, "targetDate": { "format": "date-time", "type": "string" }, "typedId": { "type": "string" }, "unitOfMeasure": { "maxLength": 255, "type": "string" }, "updateDate": { "format": "date-time", "type": "string" }, "updatedBy": { "type": "integer" }, "version": { "type": "integer" }, "warnings": { "type": "string" }, "workStatus": { "maxLength": 15, "type": "string" }, "alerts": { "type": "string" }, "allCalculationResults": { "items": { "additionalProperties": { "type": "object" }, "type": "object" }, "type": "array" }, "allowedOverrides": { "maxLength": 1300, "type": "string" }, "approvalState": { "type": "integer" }, "attribute1": { "maxLength": 70, "type": "string" }, "attribute2": { "maxLength": 70, "type": "string" }, "attribute3": { "maxLength": 70, "type": "string" }, "attribute4": { "maxLength": 70, "type": "string" }, "attribute5": { "maxLength": 70, "type": "string" }, "attribute6": { "maxLength": 70, "type": "string" }, "attribute7": { "maxLength": 70, "type": "string" }, "attribute8": { "maxLength": 70, "type": "string" }, "attribute9": { "maxLength": 70, "type": "string" }, "attribute10": { "maxLength": 70, "type": "string" }, "attribute11": { "maxLength": 70, "type": "string" }, "attribute12": { "maxLength": 70, "type": "string" }, "attribute13": { "maxLength": 70, "type": "string" }, "attribute14": { "maxLength": 70, "type": "string" }, "attribute15": { "maxLength": 70, "type": "string" }, "attribute16": { "maxLength": 70, "type": "string" }, "attribute17": { "maxLength": 70, "type": "string" }, "attribute18": { "maxLength": 70, "type": "string" }, "attribute19": { "maxLength": 70, "type": "string" }, "attribute20": { "maxLength": 70, "type": "string" }, "attribute21": { "maxLength": 70, "type": "string" }, "attribute22": { "maxLength": 70, "type": "string" }, "attribute23": { "maxLength": 70, "type": "string" }, "attribute24": { "maxLength": 70, "type": "string" }, "attribute25": { "maxLength": 70, "type": "string" }, "attribute26": { "maxLength": 70, "type": "string" }, "attribute27": { "maxLength": 70, "type": "string" }, "attribute28": { "maxLength": 70, "type": "string" }, "attribute29": { "maxLength": 70, "type": "string" }, "attribute30": { "maxLength": 70, "type": "string" }, "attribute31": { "maxLength": 70, "type": "string" }, "attribute32": { "maxLength": 70, "type": "string" }, "attribute33": { "maxLength": 70, "type": "string" }, "attribute34": { "maxLength": 70, "type": "string" }, "attribute35": { "maxLength": 70, "type": "string" }, "attribute36": { "maxLength": 70, "type": "string" }, "attribute37": { "maxLength": 70, "type": "string" }, "attribute38": { "maxLength": 70, "type": "string" }, "attribute39": { "maxLength": 70, "type": "string" }, "attribute40": { "maxLength": 70, "type": "string" }, "attribute41": { "maxLength": 70, "type": "string" }, "attribute42": { "maxLength": 70, "type": "string" }, "attribute43": { "maxLength": 70, "type": "string" }, "attribute44": { "maxLength": 70, "type": "string" }, "attribute45": { "maxLength": 70, "type": "string" }, "attribute46": { "maxLength": 70, "type": "string" }, "attribute47": { "maxLength": 70, "type": "string" }, "attribute48": { "maxLength": 70, "type": "string" }, "attribute49": { "maxLength": 70, "type": "string" }, "attribute50": { "maxLength": 70, "type": "string" }, "attribute51": { "maxLength": 70, "type": "string" }, "attribute52": { "maxLength": 70, "type": "string" }, "attribute53": { "maxLength": 70, "type": "string" }, "attribute54": { "maxLength": 70, "type": "string" }, "attribute55": { "maxLength": 70, "type": "string" }, "attribute56": { "maxLength": 70, "type": "string" }, "attribute57": { "maxLength": 70, "type": "string" }, "attribute58": { "maxLength": 70, "type": "string" }, "attribute59": { "maxLength": 70, "type": "string" }, "attribute60": { "maxLength": 70, "type": "string" }, "attribute61": { "maxLength": 70, "type": "string" }, "attribute62": { "maxLength": 70, "type": "string" }, "attribute63": { "maxLength": 70, "type": "string" }, "attribute64": { "maxLength": 70, "type": "string" }, "attribute65": { "maxLength": 70, "type": "string" }, "attribute66": { "maxLength": 70, "type": "string" }, "attribute67": { "maxLength": 70, "type": "string" }, "attribute68": { "maxLength": 70, "type": "string" }, "attribute69": { "maxLength": 70, "type": "string" }, "attribute70": { "maxLength": 70, "type": "string" }, "attribute71": { "maxLength": 70, "type": "string" }, "attribute72": { "maxLength": 70, "type": "string" }, "attribute73": { "maxLength": 70, "type": "string" }, "attribute74": { "maxLength": 70, "type": "string" }, "attribute75": { "maxLength": 70, "type": "string" }, "attribute76": { "maxLength": 70, "type": "string" }, "attribute77": { "maxLength": 70, "type": "string" }, "attribute78": { "maxLength": 70, "type": "string" }, "attribute79": { "maxLength": 70, "type": "string" }, "attribute80": { "maxLength": 70, "type": "string" }, "attribute81": { "maxLength": 70, "type": "string" }, "attribute82": { "maxLength": 70, "type": "string" }, "attribute83": { "maxLength": 70, "type": "string" }, "attribute84": { "maxLength": 70, "type": "string" }, "attribute85": { "maxLength": 70, "type": "string" }, "attribute86": { "maxLength": 70, "type": "string" }, "attribute87": { "maxLength": 70, "type": "string" }, "attribute88": { "maxLength": 70, "type": "string" }, "attribute89": { "maxLength": 70, "type": "string" }, "attribute90": { "maxLength": 70, "type": "string" }, "attribute91": { "maxLength": 70, "type": "string" }, "attribute92": { "maxLength": 70, "type": "string" }, "attribute93": { "maxLength": 70, "type": "string" }, "attribute94": { "maxLength": 70, "type": "string" }, "attribute95": { "maxLength": 70, "type": "string" }, "attribute96": { "maxLength": 70, "type": "string" }, "attribute97": { "maxLength": 70, "type": "string" }, "attribute98": { "maxLength": 70, "type": "string" }, "attribute99": { "maxLength": 70, "type": "string" }, "attribute100": { "maxLength": 70, "type": "string" } } }, "icon": { "type": "string", "title": "icon", "description": "The icon is provided by DynamicIcon component, so the icon has to be defined there", "enum": [ "angle-double-left", "angle-down", "angle-down-b", "angle-right", "arrow-down", "arrow-right", "arrow-up", "bars", "bell", "blue", "brackets-curly", "calculator", "calculator-alt", "calendar-alt", "chart-line", "check", "check-circle", "circle", "clipboard-notes", "cog", "comment-alt-message", "comparison", "compress-arrows", "constructor", "copy", "corner-up-left", "corner-up-right", "critical", "crosshair", "dashboard", "database", "ellipsis-h", "equal-circle", "exclamation-octagon", "exclamation-octagon-solid", "exclamation-triangle", "exclamation-triangle-solid", "external-link-alt", "eye", "file", "file-check-alt", "file-copy-alt", "file-edit-alt", "file-info-alt", "file-plus-alt", "filter", "folder", "folder-medical", "folder-open", "fullscreen-exit", "green", "import", "info-circle", "key", "layer-group", "layer-group-slash", "link-broken", "link-h", "message", "minus", "minus-circle", "minus-square", "multiply", "pause", "pen", "play", "plus", "plus-circle", "plus-square", "process", "puzzle-piece", "question", "question-circle", "red", "redo", "retweet", "search", "search-minus", "sliders-v-alt", "sync", "times", "times-circle", "trash-alt", "upload", "user", "wrench", "yellow" ], "x-tags": [ "otherSchemas" ] }, "labelTranslations": { "type": "object", "title": "labelTranslations", "description": "Object with custom translations with structure. It tries to pick label according to your language, otherwise it pick label from `\"\"` key. After that translationKey is used.", "properties": { "additionalProperties": { "type": "string" }, "\"\"": { "type": "string" }, "fr": { "type": "string" }, "en": { "type": "string" } }, "required": [ "\"\"" ], "x-tags": [ "otherSchemas" ] }, "rule": { "type": "object", "title": "rule", "description": "A Filter rule with the actual condition.", "additionalProperties": false, "properties": { "fieldName": { "type": "string", "description": "Entity property to check." }, "operator": { "type": "string", "description": "Operator for comparing.", "enum": [ "\"equals\"", "\"notEqual\"", "\"iEquals\"", "\"iNotEqual\"", "\"greaterThan\"", "\"lessThan\"", "\"greaterOrEqual\"", "\"lessOrEqual\"", "\"isNull\"", "\"notNull\"", "\"iBetween\"", "\"iBetweenInclusive\"", "\"between\"", "\"betweenInclusive\"", "\"inSet\"", "\"notInSet\"", "\"contains\"", "\"notContains\"", "\"iContains\"", "\"iNotContains\"", "\"containsPattern\"", "\"iContainsPattern\"", "\"startsWith\"", "\"notStartsWith\"", "\"iStartsWith\"", "\"iNotStartsWith\"", "\"endsWith\"", "\"notEndsWith\"", "\"iEndsWith\"", "\"iNotEndsWith\"" ] }, "value": { "type": "string" }, "_constructor": { "type": "string", "enum": [ "AdvancedCriteria" ] } }, "required": [ "fieldName", "operator" ], "x-tags": [ "otherSchemas" ] }, "group": { "type": "object", "title": "group", "properties": { "criteria": { "type": "array", "items": { "$ref": "#/components/schemas/filter" } }, "operator": { "type": "string", "enum": [ "and", "or", "not" ] }, "_constructor": { "type": "string", "enum": [ "AdvancedCriteria" ] } }, "additionalProperties": false, "required": [ "criteria", "operator" ], "description": "Filter Group for hiding or disabling steps or tabs.", "x-tags": [ "otherSchemas" ] }, "filter": { "title": "filter", "oneOf": [ { "$ref": "#/components/schemas/group" }, { "$ref": "#/components/schemas/rule" } ], "description": "Filter can be a rule or a group of rules with a combining operator.", "x-tags": [ "otherSchemas" ] }, "tab": { "type": "object", "additionalProperties": false, "title": "tab", "description": "", "properties": { "name": { "type": "string", "title": "Tab unique name", "description": "Tab unique name. It can be used in URL, use URL-safe letters." }, "labelTranslations": { "$ref": "#/components/schemas/labelTranslations" }, "translationKey": { "type": "string", "title": "Key used to find build-in translation for Tab name", "description": "Key used to find build-in translation for Tab name. If such key exist, the translation will be used. Otherwise this string will show up on the screen.", "example": "sfdc_quotes_tabs_header" }, "userGroupViewDetails": { "type": "string", "title": "User group view permissions", "description": "User group view permissions. The list of user groups which can view the tab.", "example": "admins" }, "userGroupEdit": { "type": "string", "title": "User group edit permissions", "description": "User group edit permissions. The list of user groups which can edit the tab." }, "icon": { "$ref": "#/components/schemas/icon" }, "type": { "type": "string", "title": "Component specifier", "description": "Name of the widget you would like to see on the tab. In case of dashboard, if you can specify the dashboard name via typeReference attribute.", "enum": [ "header", "items", "attachments", "actions", "notes", "customForms", "workflow", "workflowHistory", "messages", "dashboard", "details", "documents", "configurationWizards", "externalApp" ] }, "typeReference": { "type": "string", "title": "Unique identifier for dashboard or logic.", "description": "Unique identifier for dashboard or logic. The value here depends on the widget used on the Tab." }, "disableCheck": { "$ref": "#/components/schemas/filter" }, "hiddenCheck": { "$ref": "#/components/schemas/filter" }, "parameters": { "type": "object", "title": "Static parameters for the tab.", "description": "Static parameters for the tab. Will be passed to the tab logic (e.g. dashboard) without any changes. They can be extracted by DynamicTabs.getParameters(tab, entity) in TabComponent." }, "parameterMapping": { "type": "object", "additionalProperties": { "type": "string", "title": "Dynamic parameters for the tab", "description": "Will be passed to the logic. Values will be obtained from the entity. Key value mapping of the entity fields to the dashboard logic inputs. The key is name of parameter for tab logic. The value is path to value in underlying entity." }, "properties": { "additionalProperties": { "type": "string", "description": "Dynamic parameters for the tab. Will be passed to the logic. Values will be obtained from the entity. Key value mapping of the entity fields to the dashboard logic inputs. The value is path to value in the underlying entity.", "example": "Year: inputs.Year.value" } } } }, "required": [ "name", "type" ], "x-tags": [ "otherSchemas" ] }, "step": { "title": "step", "type": "object", "properties": { "name": { "type": "string", "title": "Step unique name", "description": "It can be used in URL, so use URL-safe letters" }, "labelTranslations": { "$ref": "#/components/schemas/labelTranslations" }, "translationKey": { "type": "string", "title": "Key used to find build-in translation for Step name", "description": "If such key exist, the translation will be used. Otherwise this string will show up on the screen." }, "userGroupViewDetails": { "type": "string", "title": "User group view permissions", "description": "List of user groups names (separated by comma), which can view the step" }, "userGroupEdit": { "type": "string", "title": "User group edit permissions", "description": "List of user groups names (separated by comma), which can edit the step" }, "disableCheck": { "$ref": "#/components/schemas/filter" }, "hiddenCheck": { "$ref": "#/components/schemas/filter" }, "icon": { "$ref": "#/components/schemas/icon" }, "tabs": { "type": "array", "items": { "$ref": "#/components/schemas/tab" } } }, "x-tags": [ "otherSchemas" ] }, "configuration": { "type": "object", "title": "configuration", "description": "Schema for definition of steps and tabs. This object can contains `tabs` array with tabs specifications or `steps` array (categories) with tabs inside.", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Text to describe the configuration." }, "layout": { "type": "string", "description": "DynamicTabs can have several types of layout. Default is `stepper` for config with steps and `tabs` for only tabs.", "enum": [ "auto", "stepper", "tabs", "menu", "wizard" ], "example": "tabs" }, "steps": { "type": "array", "items": { "$ref": "#/components/schemas/step" } }, "tabs": { "type": "array", "items": { "$ref": "#/components/schemas/tab" } } }, "x-tags": [ "otherSchemas" ] }, "Comment": { "title": "Comment", "type": "object", "properties": { "typedId": { "type": "string" }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "body": { "type": "string", "maxLength": 3000 }, "version": { "type": "integer" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } }, "description": "The type code is CMNT." }, "CommentThread": { "title": "CommentThread", "type": "object", "description": "The type code is CMTRD.", "properties": { "typedId": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "createdBy": { "type": "integer" }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "version": { "type": "integer" }, "relatedObjects": { "type": "array", "description": "A transient list of strings representing the identifiers of related objects. This attribute is derived from the relations attribute.", "items": { "type": "string" } }, "resolved": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "lastUpdateBy": { "type": "integer" } } }, "TypeCodeEnum": { "title": "TypeCodeEnum", "type": "string", "enum": [ "ACTT", "AP", "APIK", "BD", "BPT", "BR", "C", "CA", "CAM", "CDESC", "CF", "CFS", "CFT", "CH", "CLLI", "CN", "CRCI", "CRCP", "CS", "CT", "CTAM", "CTLI", "CTMU", "CTMUI", "CTT", "CTTAM", "CTTREE", "CW", "CX", "CXAM", "DA", "DB", "DCR", "DCRAM", "DCRI", "DCRL", "DCRMC", "DCRT", "DE", "DI", "DM", "DMDC", "DMDL", "DMDS", "DMF", "DMM", "DMR", "DMT", "DREG", "DWT", "ET", "EVT", "F", "FE", "FN", "IDC", "IE", "ISH", "JST", "LAT", "LTT", "M", "MPL", "MPLAM", "MPLI", "MPLIT", "MPLT", "MR", "MRAM", "MT", "P", "PAM", "PAPIJ", "PBOME", "PCOMP", "PCW", "PDESC", "PG", "PGI", "PGIM", "PGT", "PH", "PL", "PLI", "PLIM", "PLT", "PR", "PRAM", "PREF", "PT", "PWH", "PX", "PXAM", "PXREF", "PYR", "PYRAM", "Q", "QAM", "QLI", "QMU", "QMUI", "QT", "QTT", "QTTAM", "R", "RAT", "RATM", "RBA", "RBAAM", "RBALI", "RBAT", "RBT", "RBTAM", "RR", "RRAM", "RRS", "RRSC", "RT", "SAT", "SC", "SCN", "SCNAM", "SCT", "SIAM", "SIM", "SIMI", "TFA", "TODO", "U", "UG", "US", "W", "WD", "WF", "WFE", "XPGI", "XPLI", "XSIMI" ], "example": "P", "description": "The list of Pricefx type codes." } }, "x-tags": [ "otherSchemas" ], "responses": { "productResponse": { "description": "Returns full record details.", "content": { "application/json": { "schema": { "description": "", "title": "productResponse", "type": "object", "properties": { "response": { "anyOf": [ { "properties": { "data": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "The Product object. The Type code is P.", "items": { "$ref": "#/components/schemas/Product" } }, "status": { "type": "number" } } }, { "description": "A nested array of values.", "properties": { "data": { "type": "array", "items": {} } } } ], "type": "object" } } }, "examples": { "listProductsResponseExample_resultFields": { "value": { "response": { "node": "node", "startRow": 0, "data": [ { "version": 8, "label": "Label One", "attribute1": "23" }, { "version": 11, "label": "Label Two", "attribute1": "33" }, { "version": 8, "label": "Label Three", "attribute1": "56" }, { "version": 13, "label": "Label Four", "attribute1": "20" }, { "version": 0, "label": "Label Five", "attribute1": "123" }, { "version": 0, "label": "Tofu", "attribute1": "2" } ], "endRow": 8, "totalRows": 8, "status": 0 } } }, "listProductsResponseExample_valueFields": { "value": { "response": { "node": "node", "startRow": 0, "data": [ [ "8", "Label One", "23" ], [ "11", "Label Two", "33" ], [ "8", "Label Three", "56" ], [ "13", "Label Four", "20" ], [ "0", "Label Five", "123" ], [ "0", "Tofu", "2" ] ], "endRow": 8, "totalRows": 8, "status": 0 } } }, "listProductsResponseExample": { "value": { "response": { "data": [ { "version": 0, "typedId": "string", "sku": "string", "label": "string", "unitOfMeasure": null, "userGroupEdit": null, "userGroupViewDetails": null, "currency": null, "formulaName": null, "image": null, "createDate": "2019-08-24T14:15:22Z", "createdBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "lastUpdateBy": 0, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null } ], "status": 0 } } } } } } }, "loaddataResponse": { "description": "Returns the number of inserted or updated objects.", "content": { "application/json": { "schema": { "description": "", "title": "loaddataResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "items": {} }, "status": { "type": "number" } } } } }, "examples": { "loaddataResponseExample": { "value": { "response": { "node": "", "data": [ 3 ], "status": 0 } } } } } } }, "customerResponse": { "description": "Returns customer record details.", "content": { "application/json": { "schema": { "description": "", "title": "customerResponse", "type": "object", "properties": { "response": { "anyOf": [ { "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "description": "The `Customer` object. The Type code is C.", "items": { "$ref": "#/components/schemas/Customer" } }, "status": { "type": "number" } } }, { "properties": { "data": { "type": "array", "items": {} } }, "description": "A nested array of values." } ], "type": "object" } } }, "examples": { "listCustomerResponseExample": { "value": { "response": { "node": "string", "data": [ { "createDate": "2019-08-24T14:15:22Z", "createdBy": 0, "customerId": "string", "isParent": true, "lastUpdateBy": 0, "lastUpdateDate": "2019-08-24T14:15:22Z", "name": "string", "nodeId": 0, "parentId": 0, "typedId": "string", "userGroupEdit": "string", "userGroupViewDetails": "string", "version": 0, "attribute1": "string", "attribute2": "string", "attribute3": "string", "attribute4": "string", "attribute5": "string", "attribute6": "string", "attribute7": "string", "attribute8": "string", "attribute9": "string", "attribute10": "string", "attribute11": "string", "attribute12": "string", "attribute13": "string", "attribute14": "string", "attribute15": "string", "attribute16": "string", "attribute17": "string", "attribute18": "string", "attribute19": "string", "attribute20": "string", "attribute21": "string", "attribute22": "string", "attribute23": "string", "attribute24": "string", "attribute25": "string", "attribute26": "string", "attribute27": "string", "attribute28": "string", "attribute29": "string", "attribute30": "string" } ], "status": 0 } } }, "listCustomerResponseExample_resultFields": { "value": { "response": { "node": "pfxnode", "startRow": 0, "data": [ { "customerId": "00001", "attribute1": "The Street 11, NY" }, { "customerId": "00002", "attribute1": "High Street 23, London" }, { "customerId": "00003", "attribute1": "Derry Lane" } ], "endRow": 7, "totalRows": 7, "status": 0 } } }, "listCustomerResponseExample_valueFields": { "value": { "response": { "node": "pricefx-cluster-app-frontend-68d6565d7b-z2tf7", "startRow": 0, "data": [ [ "00001", "The Street 11, NY" ], [ "00002", "High Street 23, London" ], [ "00003", "Derry Lane" ] ], "endRow": 7, "totalRows": 7, "status": 0 } } } } } } }, "quoteResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "quoteResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string", "minLength": 1 }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} }, "required": [ "name", "label", "url", "type", "value", "valueHint" ] } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": { "type": "array", "items": { "type": "string" } } } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": {} }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "clicId": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "number" }, "excludeFromExport": { "type": "boolean" }, "warnings": {}, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1 }, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} }, "required": [ "resultName", "resultLabel", "result", "excludeFromExport", "displayOptions", "formatType", "resultType", "overrideAllowEmpty", "overridable", "overridden" ] } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "priceRecordId": {}, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } }, "required": [ "version", "typedId", "dirty", "lineId", "calculationStatus", "editabilityStatus", "label", "sku", "folder", "treeLabel", "createDate", "createdBy", "lastUpdateDate", "lastUpdateBy" ] } }, "expiryDate": { "type": "string", "minLength": 1 }, "externalRef": {}, "customerId": { "type": "string", "minLength": 1 }, "customerName": { "type": "string", "minLength": 1 }, "customerGroup": {}, "quoteStatus": { "type": "string", "minLength": 1 }, "renderInfo": {}, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": {} }, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "approvedByName": { "type": "string", "minLength": 1 }, "deniedByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": { "type": "string", "minLength": 1 }, "rootUniqueName": { "type": "string", "minLength": 1 }, "quoteType": {}, "status": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } }, "examples": { "quoteResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 5, "typedId": "2147491345.Q", "uniqueName": "P-2147491340-REV-3", "label": "Quote01", "targetDate": "2021-11-01", "workflowStatus": "NO_APPROVAL_REQUIRED", "headerText": "

Quote message.

", "inputs": [ { "name": "Customer", "label": "Customer", "lookupTableId": null, "url": "/fetch/C/", "type": "CUSTOMER", "value": "00003", "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": [ "0pnOfOZ0RNyO8LA", "n0MnhY2gThX7adD", "IZpgAGs8pCAxG2p" ] }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Quote calculated successfully", "Quote saved\t" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [ { "version": 5, "typedId": "2147515671.QLI", "clicId": null, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "0pnOfOZ0RNyO8LA", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label One", "sku": "11111", "priceRecordId": null, "folder": false, "treeLabel": "Label One", "createDate": "2021-11-02T14:06:06", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T14:06:06", "lastUpdateBy": 2147490696 }, { "version": 5, "typedId": "2147515672.QLI", "clicId": null, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "n0MnhY2gThX7adD", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label Two", "sku": "22222", "priceRecordId": null, "folder": false, "treeLabel": "Label Two", "createDate": "2021-11-02T14:06:06", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T14:06:06", "lastUpdateBy": 2147490696 }, { "version": 5, "typedId": "2147515673.QLI", "clicId": null, "inputs": [], "outputs": [ { "resultName": "price", "resultLabel": "Price", "result": 666, "excludeFromExport": false, "warnings": null, "alertMessage": null, "alertType": null, "displayOptions": 2, "formatType": "INTEGER", "suffix": null, "resultType": "SIMPLE", "cssProperties": null, "userGroup": null, "resultGroup": null, "overrideValueOptions": null, "overrideAllowEmpty": true, "labelTranslations": null, "overridable": false, "overridden": false, "resultDescription": null } ], "dirty": false, "lineId": "IZpgAGs8pCAxG2p", "parentId": null, "calculationStatus": 0, "editabilityStatus": 0, "label": "Label Three", "sku": "33333", "priceRecordId": null, "folder": false, "treeLabel": "Label Three", "createDate": "2021-11-02T14:06:06", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T14:06:06", "lastUpdateBy": 2147490696 } ], "expiryDate": "2021-11-01", "externalRef": null, "customerId": "00003", "customerName": "Kate Smith", "customerGroup": null, "quoteStatus": "OFFER", "renderInfo": null, "serverMessagesExtended": [ { "key": "QUOTE_CALCULATED", "message": "Quote calculated successfully" }, { "key": null, "message": "Quote saved\t" } ], "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "approvedByName": "admin", "deniedByName": null, "createDate": "2021-11-02T14:01:54", "createdBy": 2147490696, "lastUpdateDate": "2021-11-02T14:06:06", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": "P-2147491340-REV-2", "rootUniqueName": "P-2147491340", "quoteType": null, "status": "DRAFT" } ], "status": 0 } } } } } } }, "pricegriditemResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "pricegriditemResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": {}, "comments": { "type": "string", "minLength": 1 }, "resultPrice": {}, "previousPrice": {}, "priceChange": {}, "priceChangePct": {}, "workStatus": {}, "alerts": {}, "warnings": {}, "allowedOverrides": {}, "manualOverrides": {}, "manualResultPrice": {}, "calculatedResultPrice": {}, "priceGridId": { "type": "number" }, "approvalState": {}, "denialReason": {}, "activePrice": {}, "priceChange_ActivePrev": {}, "priceChangePct_ActivePrev": {}, "manualEditVersion": { "type": "number" }, "manualPriceExpired": { "type": "boolean" }, "workflowStatus": {}, "submittedByName": {}, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachments": {}, "key2": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "attribute1": {}, "attribute2": {}, "attribute3": {}, "attribute4": {}, "attribute5": {}, "attribute6": {}, "attribute7": {}, "attribute8": {}, "attribute9": {}, "attribute10": {}, "attribute11": {}, "attribute12": {}, "attribute13": {}, "attribute14": {}, "attribute15": {}, "attribute16": {}, "attribute17": {}, "attribute18": {}, "attribute19": {}, "attribute20": {}, "attribute21": {}, "attribute22": {}, "attribute23": {}, "attribute24": {}, "attribute25": {}, "attribute26": {}, "attribute27": {}, "attribute28": {}, "attribute29": {}, "attribute30": {}, "attribute31": {}, "attribute32": {}, "attribute33": {}, "attribute34": {}, "attribute35": {}, "attribute36": {}, "attribute37": {}, "attribute38": {}, "attribute39": {}, "attribute40": {}, "attribute41": {}, "attribute42": {}, "attribute43": {}, "attribute44": {}, "attribute45": {}, "attribute46": {}, "attribute47": {}, "attribute48": {}, "attribute49": {}, "attribute50": {}, "attribute51": {}, "attribute52": {}, "attribute53": {}, "attribute54": {}, "attribute55": {}, "attribute56": {}, "attribute57": {}, "attribute58": {}, "attribute59": {}, "attribute60": {}, "attribute61": {}, "attribute62": {}, "attribute63": {}, "attribute64": {}, "attribute65": {}, "attribute66": {}, "attribute67": {}, "attribute68": {}, "attribute69": {}, "attribute70": {}, "attribute71": {}, "attribute72": {}, "attribute73": {}, "attribute74": {}, "attribute75": {}, "attribute76": {}, "attribute77": {}, "attribute78": {}, "attribute79": {}, "attribute80": {}, "attribute81": {}, "attribute82": {}, "attribute83": {}, "attribute84": {}, "attribute85": {}, "attribute86": {}, "attribute87": {}, "attribute88": {}, "attribute89": {}, "attribute90": {}, "attribute91": {}, "attribute92": {}, "attribute93": {}, "attribute94": {}, "attribute95": {}, "attribute96": {}, "attribute97": {}, "attribute98": {}, "attribute99": {}, "attribute100": {}, "approvalDate": {}, "denialDate": {}, "previousPriceDate": {}, "activePriceDate": {}, "manualEditUser": { "type": "number" }, "manualPriceDate": {}, "submitDate": {}, "itemExtensions": { "type": "object", "properties": {} }, "completeResultsAvailable": { "type": "boolean" } } } }, "status": { "type": "number" } } } } }, "examples": { "priceGridItemResponseExample": { "value": { "response": { "node": "", "data": [ { "version": 2, "typedId": "654.PGI", "sku": "22222", "label": "Label Two", "unitOfMeasure": "EA", "currency": null, "comments": "a comment", "resultPrice": null, "previousPrice": null, "priceChange": null, "priceChangePct": null, "workStatus": null, "alerts": null, "warnings": null, "allowedOverrides": null, "manualOverrides": null, "manualResultPrice": null, "calculatedResultPrice": null, "priceGridId": 212, "approvalState": null, "denialReason": null, "activePrice": null, "priceChange_ActivePrev": null, "priceChangePct_ActivePrev": null, "manualEditVersion": 1, "manualPriceExpired": false, "workflowStatus": null, "submittedByName": null, "approvedByName": null, "deniedByName": null, "approvalRequiredEmailAttachments": null, "key2": null, "createDate": "2021-11-08T16:53:21", "createdBy": 2147490696, "lastUpdateDate": "2021-11-09T15:29:10", "lastUpdateBy": 2147490696, "attribute1": null, "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null, "attribute9": null, "attribute10": null, "attribute11": null, "attribute12": null, "attribute13": null, "attribute14": null, "attribute15": null, "attribute16": null, "attribute17": null, "attribute18": null, "attribute19": null, "attribute20": null, "attribute21": null, "attribute22": null, "attribute23": null, "attribute24": null, "attribute25": null, "attribute26": null, "attribute27": null, "attribute28": null, "attribute29": null, "attribute30": null, "attribute31": null, "attribute32": null, "attribute33": null, "attribute34": null, "attribute35": null, "attribute36": null, "attribute37": null, "attribute38": null, "attribute39": null, "attribute40": null, "attribute41": null, "attribute42": null, "attribute43": null, "attribute44": null, "attribute45": null, "attribute46": null, "attribute47": null, "attribute48": null, "attribute49": null, "attribute50": null, "attribute51": null, "attribute52": null, "attribute53": null, "attribute54": null, "attribute55": null, "attribute56": null, "attribute57": null, "attribute58": null, "attribute59": null, "attribute60": null, "attribute61": null, "attribute62": null, "attribute63": null, "attribute64": null, "attribute65": null, "attribute66": null, "attribute67": null, "attribute68": null, "attribute69": null, "attribute70": null, "attribute71": null, "attribute72": null, "attribute73": null, "attribute74": null, "attribute75": null, "attribute76": null, "attribute77": null, "attribute78": null, "attribute79": null, "attribute80": null, "attribute81": null, "attribute82": null, "attribute83": null, "attribute84": null, "attribute85": null, "attribute86": null, "attribute87": null, "attribute88": null, "attribute89": null, "attribute90": null, "attribute91": null, "attribute92": null, "attribute93": null, "attribute94": null, "attribute95": null, "attribute96": null, "attribute97": null, "attribute98": null, "attribute99": null, "attribute100": null, "approvalDate": null, "denialDate": null, "previousPriceDate": null, "activePriceDate": null, "manualEditUser": 2147490696, "manualPriceDate": null, "submitDate": null, "itemExtensions": {}, "completeResultsAvailable": false } ], "status": 0 } } } } } } }, "pricelistitemResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "pricelistitemResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "startRow": { "type": "number" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "sku": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "unitOfMeasure": { "type": "string", "minLength": 1 }, "currency": { "type": "string", "minLength": 1 }, "comments": { "type": "string", "minLength": 1 }, "resultPrice": { "type": "number" }, "allowedOverrides": { "type": "string" }, "calculatedResultPrice": { "type": "number" }, "pricelistId": { "type": "number" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "attribute1": { "type": "number" }, "completeResultsAvailable": { "type": "boolean" }, "itemExtensions": { "type": "object" } } } }, "endRow": { "type": "number", "description": "The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.", "default": 300 }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "pricelistitemResponseExample": { "value": { "response": { "node": "", "startRow": 0, "data": [ { "version": 0, "typedId": "2147563138.PLI", "sku": "11111", "label": "Label One", "unitOfMeasure": "EA", "currency": "USD", "resultPrice": 100, "allowedOverrides": "", "calculatedResultPrice": 100, "pricelistId": 2147490401, "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "attribute1": 100, "completeResultsAvailable": true, "itemExtensions": {} }, { "version": 0, "typedId": "2147563139.PLI", "sku": "22222", "label": "Label Two", "unitOfMeasure": "EA", "currency": "EUR", "comments": "a comment", "resultPrice": 200, "allowedOverrides": "", "calculatedResultPrice": 200, "pricelistId": 2147490401, "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "attribute1": 200, "completeResultsAvailable": true, "itemExtensions": {} }, { "version": 0, "typedId": "2147563140.PLI", "sku": "33333", "label": "Label Three", "unitOfMeasure": "EA", "currency": "CZK", "resultPrice": 300, "allowedOverrides": "", "calculatedResultPrice": 300, "pricelistId": 2147490401, "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "attribute1": 300, "completeResultsAvailable": true, "itemExtensions": {} }, { "version": 0, "typedId": "2147563142.PLI", "sku": "123456789", "label": "The Label24", "unitOfMeasure": "EA", "currency": "USD", "warnings": "{\"MarginPct\":[\"WTF?! Margin!\"],\"ListPrice\":[\"WTF?!\"],\"CompetitivePositioning\":[\"Product attribute BusinessUnit not found\",\"VLookup table CompetitionStrategy not found\"]}", "allowedOverrides": "", "pricelistId": 2147490401, "createDate": "2021-11-10T12:38:30", "createdBy": 2147490696, "completeResultsAvailable": true, "itemExtensions": {} } ], "endRow": 4, "totalRows": 4, "status": 0 } } } } } } }, "contractResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "contractResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "status": { "type": "number" }, "startRow": { "type": "number" }, "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string" }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "numberOfAttachments": { "type": "number" }, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "rootUniqueName": { "type": "string", "minLength": 1 } } } }, "endRow": { "type": "number" } } } } }, "examples": { "contractResponseExample": { "value": { "response": { "status": 0, "startRow": 0, "node": "", "csrfToken": "", "data": [ { "version": 3, "typedId": "170.CT", "uniqueName": "C-170", "label": "New Agreement & Promotion", "targetDate": "2021-11-18", "workflowStatus": "DRAFT", "lastUpdateByName": "admin", "createdByName": "admin", "calculationStatus": 0, "dirty": false, "refreshInputs": false, "numberOfAttachments": 0, "contractStatus": "DRAFT", "startDate": "2021-11-18", "endDate": "2021-11-18", "status": "DRAFT", "hasWorkflowHistory": false, "createDate": "2021-11-18T15:48:25", "createdBy": 2147490696, "lastUpdateDate": "2021-11-18T15:48:25", "lastUpdateBy": 2147490696, "rootUniqueName": "C-170" } ], "endRow": 1 } } } } } } }, "rebateagreementResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "rebateagreementResponse", "type": "object", "properties": { "response": { "type": "object", "required": [ "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string" }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": { "type": "object", "properties": { "customerFieldName": { "type": "string", "minLength": 1 }, "customerFieldValue": { "type": "string", "minLength": 1 }, "customerFieldLabel": { "type": "string", "minLength": 1 } } }, "valueHint": { "type": "string", "minLength": 1 }, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": {}, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": { "type": "object", "properties": { "gridViewState": {}, "openFolders": {}, "selectedNodes": {} } }, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": { "type": "string" } }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "items": { "type": "object" } }, "seller": {}, "customerGroup": { "type": "object", "properties": { "label": {}, "customerFieldName": { "type": "string", "minLength": 1 }, "customerFieldLabel": { "type": "string", "minLength": 1 }, "customerFieldValue": { "type": "string", "minLength": 1 }, "customerFilterCriteria": {} } }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "payoutDate": { "type": "string", "minLength": 1 }, "rebateRecordSetId": {}, "rebateRecordSetLabel": {}, "simulationSet": {}, "simulationType": {}, "status": { "type": "string", "minLength": 1 }, "rebateAgreementStatus": { "type": "string", "minLength": 1 }, "approvedByName": {}, "deniedByName": {}, "renderInfo": {}, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "key": {}, "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] } }, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 }, "headerRebateType": {}, "sellerName": {} } } }, "status": { "type": "number" } } } } }, "examples": { "rebateAgreementReponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 4, "typedId": "2147483868.RBA", "uniqueName": "R-2147483868", "label": "RBA001", "targetDate": "2021-11-26", "workflowStatus": "DRAFT", "headerText": "", "inputs": [ { "name": "CustomerGroup", "label": "Customer(s)", "lookupTableId": null, "url": null, "type": "CUSTOMERGROUP", "value": { "customerFieldName": "customerId", "customerFieldValue": "00003", "customerFieldLabel": "customerId" }, "valueHint": "Kate Smith", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null }, { "name": "ProductGroup", "label": "Product(s)", "lookupTableId": null, "url": null, "type": "PRODUCTGROUP", "value": { "productFilterCriteria": { "_constructor": "AdvancedCriteria", "operator": "or", "criteria": [ { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "11111" } ] }, { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "22222" } ] }, { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "sku", "operator": "iEquals", "value": "33333" } ] } ] }, "label": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333" }, "valueHint": "SKU equals to 11111 or SKU equals to 22222 or SKU equals to 33333", "readOnly": null, "filter": null, "parameterGroup": null, "required": null, "labelTranslations": null, "addUnknownValues": null, "typedId": null, "alwaysEditable": null, "inputs": [], "parameterConfig": {}, "formattingOptions": {}, "valueOptions": null } ], "viewState": { "gridViewState": null, "openFolders": null, "selectedNodes": null }, "outputs": [], "lastUpdateByName": "admin", "createdByName": "admin", "submittedByName": null, "calculationStatus": 0, "dirty": false, "refreshInputs": false, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "serverMessages": [ "Rebates calculated successfully" ], "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "numberOfAttachments": 0, "creationWorkflowStatus": null, "creationWorkflowCurrentStep": null, "creationWorkflowStepCount": null, "creationWorkflowStepLabel": null, "signature": null, "lineItems": [], "seller": null, "customerGroup": { "label": null, "customerFieldName": "customerId", "customerFieldLabel": "customerId", "customerFieldValue": "00003", "customerFilterCriteria": null }, "startDate": "2021-11-26", "endDate": "2021-11-26", "payoutDate": "2021-11-26", "rebateRecordSetId": null, "rebateRecordSetLabel": null, "simulationSet": null, "simulationType": null, "status": "DRAFT", "rebateAgreementStatus": "DRAFT", "approvedByName": null, "deniedByName": null, "renderInfo": null, "serverMessagesExtended": [ { "key": null, "message": "Rebates calculated successfully" } ], "approvalRequiredEmailAttachmentsJson": null, "hasWorkflowHistory": false, "createDate": "2021-11-26T13:43:47", "createdBy": 2147490696, "lastUpdateDate": "2021-11-26T13:43:47", "lastUpdateBy": 2147490696, "supersededBy": null, "prevRev": null, "rootUniqueName": "R-2147483868", "headerRebateType": null, "sellerName": null } ], "status": 0 } } } } } } }, "dmobjectResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "dmobjectResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "fields": { "type": "array", "items": { "properties": {} } }, "keyFields": { "type": "array", "items": { "properties": {} } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "sourceTypeCode": { "type": "string", "minLength": 1 }, "sourceId": { "type": "string", "minLength": 1 }, "sourceLabel": { "type": "string", "minLength": 1 }, "fetchVerb": { "type": "string", "minLength": 1 }, "bulkloadVerb": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "queryable": { "type": "boolean" }, "view": { "type": "boolean" }, "sourceName": { "type": "string", "minLength": 1 }, "draft": { "type": "boolean" }, "locked": { "type": "boolean" }, "valid": { "type": "boolean" }, "fieldNames": { "type": "array", "items": { "properties": {} } }, "keyFieldNames": { "type": "array", "items": { "properties": {} } }, "deployed": { "type": "boolean" }, "auxiliary": { "type": "boolean" }, "loadableFields": { "type": "array", "items": { "properties": {} } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "persistedObjectClass": { "type": "string", "minLength": 1 }, "isPlasma": { "type": "boolean" } } } }, "endRow": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "dmobjectResponseExample": { "value": { "response": { "node": "node", "csrfToken": "tkn", "data": [ { "version": 0, "typedId": "2147483813.DMF", "uniqueName": "Feed", "label": "Feed", "fields": [], "keyFields": [], "lastUpdateByName": "admin", "sourceTypeCode": "SL", "sourceId": "Seller", "sourceLabel": "Seller", "fetchVerb": "datamart.fetch/2147483813.DMF", "bulkloadVerb": "datamart.loaddata/Feed", "type": "FEED", "queryable": true, "view": false, "sourceName": "DMF.Feed", "draft": false, "locked": false, "valid": true, "fieldNames": [], "keyFieldNames": [], "deployed": false, "auxiliary": false, "loadableFields": [], "createDate": "2021-12-02T16:37:01", "createdBy": 2147490696, "lastUpdateDate": "2021-12-02T16:37:01", "lastUpdateBy": 2147490696, "persistedObjectClass": "net.pricefx.domain.Seller", "isPlasma": false } ], "endRow": 1, "status": 0 } } } } } } }, "logicResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "logicResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "properties": { "formula": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaNature": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "formulaType": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } } } }, "status": { "type": "number" } } } } }, "examples": { "logicResponseExample": { "value": { "response": { "node": "node", "data": [ { "formula": { "version": 7, "typedId": "2147484837.F", "uniqueName": "PriceList", "label": "Price List", "validAfter": "2021-07-12", "status": "ACTIVE", "simulationSet": null, "userGroupEdit": null, "userGroupViewDetails": null, "formulaNature": null, "lastUpdateByName": "admin", "formulaType": "PRICING", "createdByName": null, "createDate": "2021-11-04T14:56:11", "createdBy": 2147490696, "lastUpdateDate": "2021-12-08T15:45:57", "lastUpdateBy": 2147490696 } } ], "status": 0 } } } } } } }, "userResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "userResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "loginName": { "type": "string", "minLength": 1 }, "firstName": { "type": "string", "minLength": 1 }, "lastName": { "type": "string", "minLength": 1 }, "email": { "type": "string", "minLength": 1 }, "groups": {}, "businessRoles": {}, "activated": { "type": "boolean" }, "workflowEmailingActivated": { "type": "boolean" }, "noSession": { "type": "boolean" }, "requireTFA": { "type": "boolean" }, "receiveAdminEmail": { "type": "boolean" }, "ssoOnly": { "type": "boolean" }, "wizardDashboardName": {}, "firstLogin": { "type": "boolean" }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "emailLocale": { "type": "string", "minLength": 1 }, "defaultUserGroupEdit": { "type": "string", "minLength": 1 }, "defaultUserGroupViewDetails": { "type": "string", "minLength": 1 }, "productFilterCriteria": {}, "customerFilterCriteria": {}, "roleNames": { "type": "array", "items": { "type": "object" } }, "allRoleNames": { "type": "array", "items": { "type": "object" } }, "allGroups": { "type": "array", "items": { "type": "object" } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastLogin": {}, "lastUpdateBy": { "type": "number" }, "extendedData": {}, "passwordExpiry": {} } } }, "status": { "type": "number" } } } } }, "examples": { "userResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 0, "typedId": "2147491062.U", "loginName": "john.pricer", "firstName": "Tim", "lastName": "Smith", "email": "non@existent33.com", "groups": null, "businessRoles": null, "activated": true, "workflowEmailingActivated": true, "noSession": true, "requireTFA": true, "receiveAdminEmail": true, "ssoOnly": true, "wizardDashboardName": null, "firstLogin": false, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "emailLocale": "en", "defaultUserGroupEdit": "Administrators", "defaultUserGroupViewDetails": "Administrators", "productFilterCriteria": null, "customerFilterCriteria": null, "roleNames": [], "allRoleNames": [], "allGroups": [], "createDate": "2021-12-12T12:59:07", "createdBy": 2147490696, "lastLogin": null, "lastUpdateBy": 2147490696, "extendedData": null, "passwordExpiry": null } ], "status": 0 } } } } } } }, "manualpricelistResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "manualpricelistResponse", "type": "object", "properties": { "response": { "type": "object", "required": [ "node", "data", "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "csrfToken": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "linkedCFStypedId": {}, "expiryDate": {}, "integrationStatus": {}, "targetDate": {}, "createdByName": { "type": "string", "minLength": 1 }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } }, "examples": { "manualpricelistResponseExample": { "value": { "response": { "node": "node", "csrfToken": "token", "data": [ { "version": 3, "typedId": "225.MPL", "uniqueName": "MPL01", "label": "The Manual Price List 1", "validAfter": "2021-12-12", "status": "INACTIVE", "simulationSet": null, "nodeId": null, "userGroupEdit": null, "userGroupViewDetails": null, "linkedCFStypedId": null, "expiryDate": null, "integrationStatus": null, "targetDate": null, "createdByName": "admin", "lastUpdateByName": "admin", "createDate": "2021-12-12T15:37:01", "createdBy": 2147490696, "lastUpdateDate": "2021-12-12T17:19:31", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } }, "typecodesResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "typecodesResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "massEditable": { "type": "boolean" }, "bulkLoadable": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 }, "className": { "type": "string", "minLength": 1 }, "codeString": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } }, "assignmentResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "assignmentResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "customerGroup": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "customerFieldName": {}, "customerFieldLabel": {}, "customerFieldValue": {}, "customerFilterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "array", "items": { "type": "string" } } } } }, "operator": { "type": "string", "minLength": 1 } } } } }, "assignmentId": { "type": "number" }, "priority": { "type": "number" }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "assignment": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } }, "status": { "type": "number" } } } } }, "examples": { "assignmentResponseExample": { "value": { "response": { "node": "e2e-templates-node", "data": [ { "version": 1, "typedId": "3.CA", "customerGroup": { "label": "00002,00003", "customerFieldName": null, "customerFieldLabel": null, "customerFieldValue": null, "customerFilterCriteria": { "_constructor": "AdvancedCriteria", "criteria": [ { "fieldName": "customerId", "operator": "inSet", "value": [ "00002", "00003" ] } ], "operator": "and" } }, "assignmentId": 211, "priority": 1, "additionalInfo1": null, "additionalInfo2": null, "additionalInfo3": null, "additionalInfo4": null, "lastUpdateByName": "admin", "createdByName": "admin", "assignment": "211.PG", "createDate": "2021-12-13T10:11:09", "createdBy": 2147490696, "lastUpdateDate": "2021-12-13T10:11:09", "lastUpdateBy": 2147490696 } ], "status": 0 } } } } } } }, "contractModelResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "contractModelResponse", "type": "object", "properties": { "response": { "type": "object", "required": [ "status" ], "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "targetDate": { "type": "string", "minLength": 1 }, "workflowStatus": { "type": "string", "minLength": 1 }, "headerText": { "type": "string" }, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": { "type": "string", "minLength": 1 }, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object" }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "viewState": {}, "outputs": { "type": "array", "items": { "type": "object" } }, "lastUpdateByName": { "type": "string", "minLength": 1 }, "createdByName": { "type": "string", "minLength": 1 }, "submittedByName": {}, "calculationStatus": { "type": "number" }, "dirty": { "type": "boolean" }, "refreshInputs": { "type": "boolean" }, "nodeId": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "serverMessages": { "type": "array", "items": { "type": "object" } }, "additionalInfo1": {}, "additionalInfo2": {}, "additionalInfo3": {}, "additionalInfo4": {}, "numberOfAttachments": { "type": "number" }, "creationWorkflowStatus": {}, "creationWorkflowCurrentStep": {}, "creationWorkflowStepCount": {}, "creationWorkflowStepLabel": {}, "signature": {}, "lineItems": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": {}, "typedId": {}, "clicId": {}, "inputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "lookupTableId": {}, "url": {}, "type": { "type": "string", "minLength": 1 }, "value": {}, "valueHint": {}, "readOnly": {}, "filter": {}, "parameterGroup": {}, "required": {}, "labelTranslations": {}, "addUnknownValues": {}, "typedId": { "type": "string", "minLength": 1 }, "alwaysEditable": {}, "inputs": { "type": "array", "items": { "type": "object" } }, "parameterConfig": { "type": "object", "properties": { "dataType": { "type": "string", "minLength": 1 } } }, "formattingOptions": { "type": "object" }, "valueOptions": {} } } }, "outputs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "resultName": { "type": "string", "minLength": 1 }, "resultLabel": { "type": "string", "minLength": 1 }, "result": { "type": "string", "minLength": 1 }, "excludeFromExport": { "type": "boolean" }, "warnings": { "type": "array", "items": { "type": "object" } }, "alertMessage": {}, "alertType": {}, "displayOptions": { "type": "number" }, "formatType": {}, "suffix": {}, "resultType": { "type": "string", "minLength": 1 }, "cssProperties": {}, "userGroup": {}, "resultGroup": {}, "overrideValueOptions": {}, "overrideAllowEmpty": { "type": "boolean" }, "labelTranslations": {}, "overridable": { "type": "boolean" }, "overridden": { "type": "boolean" }, "resultDescription": {} } } }, "dirty": { "type": "boolean" }, "lineId": { "type": "string", "minLength": 1 }, "parentId": {}, "calculationStatus": { "type": "number" }, "editabilityStatus": { "type": "number" }, "label": { "type": "string", "minLength": 1 }, "startDate": {}, "endDate": {}, "priceRecordId": {}, "customerGroup": {}, "productGroup": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "productFieldName": {}, "productFieldLabel": {}, "productFieldValue": {}, "productFilterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "operator" ] } } } } }, "required": [ "label", "productFilterCriteria" ] }, "calculationBaseJson": { "type": "string", "minLength": 1 }, "calculationBase": { "type": "object", "properties": { "includedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "includedProductGroups": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "productFieldName": {}, "productFieldLabel": {}, "productFieldValue": {}, "productFilterCriteria": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "operator" ] } } }, "required": [ "_constructor", "operator", "criteria" ] } }, "required": [ "label" ] } }, "includedSellerReferences": { "type": "array", "items": { "type": "object" } }, "excludedCustomerGroups": { "type": "array", "items": { "type": "object" } }, "excludedproductGroups": { "type": "array", "items": { "type": "object" } }, "excludedSellerReferences": { "type": "array", "items": { "type": "object" } }, "includedTimePeriods": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "timeUnit": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "single": { "type": "boolean" } }, "required": [ "timeUnit", "startDate", "endDate", "single" ] } }, "excludedTimePeriods": { "type": "array", "items": { "type": "object" } }, "otherFilters": { "type": "array", "items": { "type": "object" } }, "dateDimFieldName": { "type": "string", "minLength": 1 } }, "required": [ "includedCustomerGroups", "includedProductGroups", "includedSellerReferences", "excludedCustomerGroups", "excludedproductGroups", "excludedSellerReferences", "includedTimePeriods", "excludedTimePeriods", "otherFilters", "dateDimFieldName" ] }, "folder": { "type": "boolean" }, "treeLabel": { "type": "string", "minLength": 1 }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "contractTermType": { "type": "string", "minLength": 1 } } } }, "customerGroup": {}, "productGroup": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "productFieldName": {}, "productFieldLabel": {}, "productFieldValue": {}, "productFilterCriteria": { "type": "object", "required": [ "_constructor", "operator", "criteria" ], "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "_constructor": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "criteria": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "fieldName": { "type": "string", "minLength": 1 }, "operator": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } }, "required": [ "fieldName", "operator", "value" ] } } }, "required": [ "_constructor", "operator" ] } } } } }, "required": [ "label", "productFilterCriteria" ] }, "externalRef": {}, "contractStatus": { "type": "string", "minLength": 1 }, "startDate": { "type": "string", "minLength": 1 }, "endDate": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "approvedByName": {}, "deniedByName": {}, "approvalRequiredEmailAttachmentsJson": {}, "hasWorkflowHistory": { "type": "boolean" }, "renderInfo": {}, "serverMessagesExtended": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "key": {}, "message": { "type": "string", "minLength": 1 } }, "required": [ "message" ] } }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "supersededBy": {}, "prevRev": {}, "rootUniqueName": { "type": "string", "minLength": 1 } } } }, "status": { "type": "number" } } } } } } } }, "ProductExtensionResponse": { "description": "A Product Extension response.", "content": { "application/json": { "schema": { "description": "", "title": "ProductExtensionResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "anyOf": [ { "$ref": "#/components/schemas/PX3" }, { "$ref": "#/components/schemas/PX6" }, { "$ref": "#/components/schemas/PX8" }, { "$ref": "#/components/schemas/PX10" }, { "$ref": "#/components/schemas/PX20" }, { "$ref": "#/components/schemas/PX30" }, { "$ref": "#/components/schemas/PX50" } ] } }, "endRow": { "type": "number" }, "totalRows": { "type": "number" }, "status": { "type": "number" } } } } }, "examples": { "ProductExtensionResponseExample": { "value": { "response": { "node": "e2e-staging-node", "data": [ { "version": 1, "typedId": "20.PX8", "name": "pcost", "sku": "11111", "createDate": "2021-11-04T17:01:34", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T17:02:34", "lastUpdateBy": 2147490696, "attribute1": "100", "attribute2": null, "attribute3": null, "attribute4": null, "attribute5": null, "attribute6": null, "attribute7": null, "attribute8": null } ], "endRow": 1, "totalRows": 1, "status": 0 } } } } } } }, "JobStatusTrackerResponse": { "description": "Example response", "content": { "application/json": { "schema": { "description": "", "title": "JobStatusTrackerResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string", "minLength": 1 }, "data": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "step": { "type": "string", "minLength": 1 }, "totalJobsCount": { "type": "number" }, "jobs": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "processingNode": {}, "threadId": {}, "threadUUID": {}, "status": { "type": "string", "minLength": 1 }, "trackerType": { "type": "string", "minLength": 1 }, "targetObject": { "type": "string", "minLength": 1 }, "jobName": { "type": "string", "minLength": 1 }, "concurrencyKey": { "type": "string", "minLength": 1 }, "calculationContext": { "type": "string", "minLength": 1 }, "progress": {}, "cancelRequested": { "type": "boolean" }, "runNumber": { "type": "number" }, "priority": { "type": "number" }, "messages": {}, "jobSettings": { "type": "object", "properties": { "distributedAction": {}, "jobType": { "type": "string", "minLength": 1 }, "uuid": { "type": "string", "minLength": 1 }, "calculableObjectTypedId": { "type": "string", "minLength": 1 }, "queueName": {}, "runNumber": { "type": "number" }, "partitionName": { "type": "string", "minLength": 1 }, "partitionUUID": { "type": "string", "minLength": 1 }, "enableDirtyTracking": { "type": "boolean" }, "agentOption1": { "type": "boolean" }, "jobSize": { "type": "number" }, "distributed": { "type": "boolean" } }, "required": [ "jobType", "uuid", "calculableObjectTypedId", "runNumber", "partitionName", "partitionUUID", "enableDirtyTracking", "agentOption1", "jobSize", "distributed" ] }, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "calculationResults": {}, "processingStart": {}, "processingEnd": {}, "id": { "type": "number" } } } } } } }, "status": { "type": "number" } } } } }, "examples": { "JobStatusTrackerResponseExample": { "value": { "response": { "node": "e2e-staging-node", "data": [ { "step": "definition", "totalJobsCount": 1, "jobs": [ { "version": 1, "typedId": "2147850830.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "WAITING_FOR_DISPATCH", "trackerType": "MODEL_CALCULATION", "targetObject": "2.MO", "jobName": "MC feature test", "concurrencyKey": "2.MO", "calculationContext": "definition / wrangling", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "AyJLG", "calculableObjectTypedId": "2.MO", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "9kYHw03vOE", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2022-01-13T14:42:49", "createdBy": 2147490187, "lastUpdateDate": "2022-01-13T14:42:49", "lastUpdateBy": 2147490187, "calculationResults": null, "processingStart": null, "processingEnd": null, "id": 2147850830 } ] }, { "step": "results", "totalJobsCount": 3, "jobs": [ { "version": 5, "typedId": "2147819863.JST", "processingNode": "e2e-templates-node", "threadId": 1398, "threadUUID": "AaEDr", "status": "FINISHED", "trackerType": "MODEL_CALCULATION", "targetObject": "2.MO", "jobName": "MC feature test", "concurrencyKey": "2147819862.JST", "calculationContext": "results / run_optimization", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "AaEDr", "calculableObjectTypedId": "2.MO", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "sp3ssiBm4G", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2021-12-02T08:49:23", "createdBy": 2147484799, "lastUpdateDate": "2021-12-02T08:50:13", "lastUpdateBy": 2147484799, "calculationResults": null, "processingStart": "2021-12-02T08:50:13", "processingEnd": "2021-12-02T08:50:13", "id": 2147819863 }, { "version": 3, "typedId": "2147819864.JST", "processingNode": null, "threadId": null, "threadUUID": null, "status": "FAILED", "trackerType": "JOB_TRIGGER_CALCULATION", "targetObject": "2.MO", "jobName": "MC feature test", "concurrencyKey": "2147819863.JST", "calculationContext": "results / run_optimization / oe", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "3kbQt", "calculableObjectTypedId": "2.MO", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "sp3ssiBm4G", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2021-12-02T08:50:13", "createdBy": 2147484799, "lastUpdateDate": "2021-12-02T08:50:14", "lastUpdateBy": 2147484799, "calculationResults": null, "processingStart": null, "processingEnd": "2021-12-02T08:50:14", "id": 2147819864 } ] }, { "step": "configuration", "totalJobsCount": 1, "jobs": [ { "version": 5, "typedId": "2147819860.JST", "processingNode": "e2e-templates-node", "threadId": 1398, "threadUUID": "8Vm39", "status": "FINISHED", "trackerType": "MODEL_CALCULATION", "targetObject": "2.MO", "jobName": "MC feature test", "concurrencyKey": "2.MO", "calculationContext": "configuration", "progress": null, "cancelRequested": false, "runNumber": 0, "priority": 0, "messages": null, "jobSettings": { "distributedAction": null, "jobType": "MO", "uuid": "8Vm39", "calculableObjectTypedId": "2.MO", "queueName": null, "runNumber": 0, "partitionName": "seeddata", "partitionUUID": "sp3ssiBm4G", "enableDirtyTracking": true, "agentOption1": false, "jobSize": 0, "distributed": false }, "createDate": "2021-12-02T08:48:40", "createdBy": 2147484799, "lastUpdateDate": "2021-12-02T08:49:00", "lastUpdateBy": 2147484799, "calculationResults": null, "processingStart": "2021-12-02T08:48:58", "processingEnd": "2021-12-02T08:49:00", "id": 2147819860 } ] } ], "status": 0 } } } } } } }, "generalResponse": { "description": "A general response that contains `data` property with a content depending on returned objects (e.g., Product master table fields when calling the `/fetch/P` endpoint). Can be `null`.", "content": { "application/json": { "schema": { "description": "", "title": "generalResponse", "type": "object", "properties": { "response": { "type": "object", "properties": { "node": { "type": "string" }, "data": { "type": "object", "nullable": true }, "status": { "type": "integer" }, "startRow": { "type": "integer" }, "endRow": { "type": "integer" } } } } }, "examples": { "generalResponseExample": { "value": { "response": { "node": "string", "data": null, "status": 0, "startRow": 0, "endRow": 0 } } } } } } }, "tokenResponse": { "description": "Login was successful. The response contains the access token, token type and the refresh token.", "content": { "application/json": { "schema": { "description": "", "title": "tokenResponse", "type": "object", "properties": { "access-token": { "type": "string", "minLength": 1 }, "refresh-token": { "type": "string", "minLength": 1 }, "token-type": { "type": "string", "minLength": 1 }, "expires-in": { "type": "number" } }, "required": [ "access-token", "refresh-token", "token-type", "expires-in" ] } } } } }, "securitySchemes": { "X-PriceFx-jwt": { "name": "X-PriceFx-jwt", "type": "apiKey", "in": "header" }, "basic": { "type": "http", "scheme": "basic" } }, "requestBodies": { "pricingLogicObject": { "content": { "application/json": { "schema": { "title": "pricingLogicObjectRequest", "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "uniqueName": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "validAfter": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "simulationSet": {}, "userGroupEdit": {}, "userGroupViewDetails": {}, "formulaNature": {}, "lastUpdateByName": { "type": "string", "minLength": 1 }, "elements": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "type": "object", "properties": { "version": { "type": "number" }, "typedId": { "type": "string", "minLength": 1 }, "elementName": { "type": "string", "minLength": 1 }, "elementLabel": { "type": "string", "minLength": 1 }, "elementDescription": {}, "elementGroups": { "type": "array", "items": { "type": "string" } }, "conditionElementName": {}, "hideWarnings": { "type": "boolean" }, "excludeFromExport": { "type": "boolean" }, "protectedExpression": { "type": "boolean" }, "elementTimeout": { "type": "number" }, "displayOptions": { "type": "number" }, "formatType": { "type": "string", "minLength": 1, "nullable": true }, "elementSuffix": {}, "allowOverride": { "type": "boolean" }, "summarize": { "type": "boolean" }, "hideOnNull": { "type": "boolean" }, "userGroup": {}, "cssProperties": {}, "resultGroup": {}, "combinationType": { "type": "string", "minLength": 1 }, "storeInAttributeExtension": { "type": "boolean" }, "criticalAlert": {}, "redAlert": {}, "yellowAlert": {}, "labelTranslations": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" }, "formulaExpression": { "type": "string", "minLength": 1 } } } }, "inputDescriptors": { "type": "array", "items": { "type": "object" } }, "formulaType": { "type": "string", "minLength": 1 }, "createdByName": {}, "createDate": { "type": "string", "minLength": 1 }, "createdBy": { "type": "number" }, "lastUpdateDate": { "type": "string", "minLength": 1 }, "lastUpdateBy": { "type": "number" } } } } }, "examples": { "pricingLogicObject": { "value": { "data": { "version": 6, "typedId": "2147484837.F", "uniqueName": "PriceList", "label": "Price List", "validAfter": "2021-07-12", "status": "ACTIVE", "simulationSet": null, "userGroupEdit": null, "userGroupViewDetails": null, "formulaNature": null, "lastUpdateByName": "admin", "elements": [ { "version": 9, "typedId": "2147494038.FE", "elementName": "BasePrice", "elementLabel": "Base Price", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 21, "formatType": "MONEY_EUR", "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:11", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:16:42", "lastUpdateBy": 2147490696, "formulaExpression": "def avgCost = api.productExtension(\"pcost\")?.find()?.attribute1\nif(avgCost == null){\n api.addWarning(\"Could not find Average Cost in PX table ProductCost\")\n}\nreturn avgCost" }, { "version": 9, "typedId": "2147494043.FE", "elementName": "ListPrice", "elementLabel": "List Price", "elementDescription": null, "elementGroups": [], "conditionElementName": null, "hideWarnings": false, "excludeFromExport": false, "protectedExpression": false, "elementTimeout": 0, "displayOptions": 5, "formatType": null, "elementSuffix": null, "allowOverride": false, "summarize": false, "hideOnNull": false, "userGroup": null, "cssProperties": null, "resultGroup": null, "combinationType": "FUNCTION", "criticalAlert": null, "redAlert": null, "yellowAlert": null, "labelTranslations": null, "createDate": "2021-11-04T14:56:11", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:16:42", "lastUpdateBy": 2147490696, "formulaExpression": "def listPrice = out.BasePrice\n\n\nreturn listPrice" } ], "inputDescriptors": [], "formulaType": "PRICING", "createdByName": null, "createDate": "2021-11-04T14:56:11", "createdBy": 2147490696, "lastUpdateDate": "2021-11-04T18:16:42", "lastUpdateBy": 2147490696 } } } } } } }, "executeLogic": { "content": { "application/json": { "schema": { "description": "", "title": "executeLogicRequest", "type": "object", "properties": { "data": { "type": "object", "description": "Provide inputs for the logic as key-value pairs." } } }, "examples": { "executeLogicRequestExample": { "value": { "data": { "priority": "high", "quantity": 14, "map": { "key": "value" } } } } } } }, "description": "" }, "fetchRequest": { "content": { "application/json": { "schema": { "type": "object", "title": "fetchRequest", "properties": { "endRow": { "type": "integer" }, "oldValues": { "type": "object", "nullable": true }, "operationType": { "type": "string" }, "startRow": { "type": "integer" }, "textMatchStyle": { "type": "string" }, "data": { "type": "object", "properties": { "_constructor": { "type": "string" }, "operator": { "type": "string" }, "criteria": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "examples": { "fetchRequestExample": { "value": { "endRow": 300, "oldValues": null, "operationType": "fetch", "startRow": 0, "textMatchStyle": "exact", "data": { "_constructor": "AdvancedCriteria", "operator": "and", "criteria": [ { "fieldName": "lastUpdateDate", "operator": "greaterOrEqual", "value": "2023-06-26T22:00:00.000Z" } ] } } } } } }, "description": "A general fetch request. A filter can be applied." }, "deleteRequest": { "content": { "application/json": { "schema": { "type": "object", "title": "deleteRequest", "properties": { "data": { "type": "object", "required": [ "typedId" ], "properties": { "typedId": { "type": "string" } } } }, "required": [ "data" ] }, "examples": { "deleteRequestExample": { "value": { "data": { "typedId": "29.AIT" } } } } } }, "description": "The general delete request. Deletes the object specified by `typedId` in the request body." } }, "parameters": { "timeout": { "name": "timeout", "in": "query", "required": false, "schema": { "type": "string", "example": "20", "default": "60" }, "description": "Set this parameter to override the default timeout (60 seconds) of the query. The maximum allowed timeout is 300 seconds. The default timeout value and the maximum timeout value can be configured in the backend. Setting higher timeout can be useful, for example, when a query takes long time (e.g., when processing large tables)." }, "id": { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The `id` is the `typedId` without the type suffix. For example, the `id` attribute of the item with `typedId` = **2147484837.PL** is **2147484837**." }, "output": { "name": "output", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "json", "xls", "csv", "pdf" ], "example": "xls" }, "description": "Specifies the format of the output file." }, "useColumnNames": { "name": "useColumnNames", "in": "query", "required": false, "schema": { "type": "string", "default": "true", "enum": [ "true", "false" ], "example": "false" }, "description": "Set to **false** to retrieve the table with labels (as used in the database) instead of names in the table header." }, "noComplexResults": { "name": "noComplexResults", "in": "query", "required": false, "schema": { "type": "boolean" }, "description": "Set to `true` to exclude large results (e.g., charts, matrix table, etc.) from response. Use the **/clicmanager.fetchoutput/{typedId}/{resultName}** (e.g., /clicmanager.fetchoutput/2147490386.Q/FlexChart) to download the result separately." }, "dataLocale": { "name": "dataLocale", "in": "query", "required": false, "schema": { "type": "string", "example": "en" }, "description": "Specifies localization of data." }, "templateName": { "name": "templateName", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Specifies the template to be used when exporting a file." }, "TypeCode": { "name": "TypeCode", "in": "path", "required": true, "description": "Specify the type code for the entity you want to work with. See [the list of Type Codes](https://pricefx.atlassian.net/wiki/spaces/KB/pages/99570616/Type+Codes) in the Pricefx Knowledge Base article.'", "schema": { "$ref": "#/components/schemas/TypeCodeEnum" } } }, "examples": {} }, "tags": [ { "name": "Action Types" }, { "name": "Actions" }, { "name": "Advanced Configuration Options" }, { "name": "Admin Tools" }, { "name": "Attachments" }, { "name": "Authentication" }, { "name": "Calculated Field Sets" }, { "name": "Calculation Grids" }, { "name": "Claim Types" }, { "name": "Claims" }, { "name": "Clicmanager" }, { "name": "Comments" }, { "name": "Competition Data" }, { "name": "Condition Records" }, { "name": "Configuration" }, { "name": "Contracts (Agreements & Promotions)" }, { "name": "Custom Forms" }, { "name": "Customer Extensions" }, { "name": "Customers" }, { "name": "Data Change Requests" }, { "name": "Data Manager" }, { "name": "Entities" }, { "name": "General" }, { "name": "Heartbeat" }, { "name": "Imports" }, { "name": "Internationalization" }, { "name": "Jobs & Tasks" }, { "name": "Key-Value Store" }, { "name": "Live Price Grids" }, { "name": "Logics" }, { "name": "Logs" }, { "name": "Lookup Tables / Company Parameters" }, { "name": "Manual Price Lists" }, { "name": "MCP" }, { "name": "Metadata" }, { "name": "Notifications" }, { "name": "Optimization" }, { "name": "otherSchemas" }, { "name": "Price Lists" }, { "name": "Product Extensions" }, { "name": "Product Image" }, { "name": "Products" }, { "name": "Quote Types" }, { "name": "Quotes" }, { "name": "Rebate Agreements" }, { "name": "Rebate Calculations" }, { "name": "Rebate Record Group" }, { "name": "Sales Compensations" }, { "name": "Seller Extensions" }, { "name": "Sellers" }, { "name": "User Admin" }, { "name": "Visual Configuration" }, { "name": "Workflow" }, { "name": "Workflow Delegation" } ], "x-tagGroups": [ { "name": "General Operations", "tags": [ "General" ] }, { "name": "Master Data", "tags": [ "Products", "Product Extensions", "Product Image", "Customers", "Customer Extensions", "Sellers", "Seller Extensions", "Condition Records", "Competition Data", "Imports", "Data Change Requests", "Lookup Tables / Company Parameters" ] }, { "name": "Administration and Configuration", "tags": [ "User Admin", "Authentication", "Admin Tools", "Logics", "Logs", "Custom Forms", "Calculated Field Sets", "Jobs & Tasks", "Advanced Configuration Options" ] }, { "name": "Analytics", "tags": [ "Data Manager" ] }, { "name": "Actionable Insights", "tags": [ "Actions", "Action Types" ] }, { "name": "Price Setting", "tags": [ "Price Lists", "Manual Price Lists", "Live Price Grids", "Calculation Grids", "Visual Configuration" ] }, { "name": "Quoting", "tags": [ "Quotes" ] }, { "name": "Agreements & Promotions", "tags": [ "Contracts (Agreements & Promotions)", "Visual Configuration" ] }, { "name": "Rebates", "tags": [ "Rebate Agreements", "Rebate Calculations", "Rebate Record Group" ] }, { "name": "Sales Compensations", "tags": [ "Sales Compensations" ] }, { "name": "Channel Management", "tags": [ "Claim Types", "Claims" ] }, { "name": "Optimization", "tags": [ "Optimization" ] }, { "name": "Workflow", "tags": [ "Workflow", "Workflow Delegation" ] }, { "name": "Files", "tags": [ "Attachments", "Product Image" ] }, { "name": "Configuration", "tags": [ "Configuration", "Internationalization" ] }, { "name": "Other", "tags": [ "Metadata", "MCP", "Clicmanager", "Comments", "Notifications", "Heartbeat", "Key-Value Store" ] }, { "name": "Schemas", "tags": [ "Entities", "otherSchemas" ] } ], "security": [ { "basic": [] }, { "X-PriceFx-jwt": [] } ] }