Add a Calculation Grid

post/calculationgridmanager.addgrid

Creates a Calculation Grid (CG) object.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
label
required
string

The name of the Calculation Grid you want to create.

targetDate
string

A target date used for the logic execution. If not specified, the system will use today's date.

keyGenerationType
required
string <= 255 characters
Possible values: "DATA_DRIVEN" "LOGIC_DRIVEN" "MANUAL"
configuration
required
string

User-defined Calculation Grid parameters.

Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (CalculationGrid)
Array
lastUpdateByName
string or null <= 255 characters
createdByName
string or null <= 255 characters
updateDate
string or null <date>
typedId
string
configuration
string
relativeTargetDateDays
integer or null
lastUpdateDate
string <date-time>
numberOfSubmittedItems
integer
numberOfAutoApprovedItems
integer
locale
string or null <= 255 characters
numberOfDeniedItems
integer
calculationDate
string or null <date-time>
keyGenerationType
string <= 255 characters
Possible values: "DATA_DRIVEN" "LOGIC_DRIVEN" "MANUAL"
writeOnlyChangedItems
boolean
userGroupViewDetails
string or null <= 255 characters
id
integer
calculationGridType
string or null <= 255 characters
Possible values: "CG1" "CG2" "CG3" "CG4" "CG5" "CG6" null
createDate
string <date-time>
calculationMessages
string or null
updatedBy
integer
numberOfApprovedItems
integer
keySize
integer
targetDate
string <date>
label
string <= 255 characters
version
integer
partialCalculationDate
string or null <date-time>
numberOfOpenItems
integer
createdBy
integer
numberOfItems
integer
userGroupEdit
string or null <= 255 characters
nodeId
integer or null
keepManualOverrides
boolean
calculationStartDate
string or null <date-time>
lastUpdateBy
integer
status
string <= 255 characters
Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
approvalLevel
string <= 255 characters
Value: "LINE_ITEM"
status
integer
Request samples
application/json
{
  • "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\":{}}"
    }
}
Response samples
application/json
{
  • "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
    }
}