Calculate a Calculation Grid

post/calculationgridmanager.calculate/{id}

Start the calculation job of the specified Calculation Grid. Returns the JobStatusTracker object (JST).

Securitybasic or X-PriceFx-jwt
Request
path Parameters
id
required
string

id of the Calculation Grid you want to calculate.

Example: 99
Request Body schema: application/json
priority
integer

A user-defined priority.

Possible values: 0 1 2 3 4 5 6 7 8 9
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (JobStatusTracker)
Array
processingStart
string or null
targetObject
string <= 255 characters
typedId
string
lastUpdateDate
string <date-time>
trackerType
string <= 255 characters
Possible values: "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" … 26 more
threadId
integer or null
object
calculationContext
string or null <= 255 characters
threadUUID
string or null <= 255 characters
id
integer
calculationResults
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

processingNode
string or null <= 255 characters
createDate
string <date-time>
jobName
string <= 255 characters
concurrencyKey
string <= 255 characters
priority
integer
version
integer
createdBy
integer
processingEnd
string or null
progress
string or null <= 255 characters
messages
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

runNumber
integer
cancelRequested
boolean
parameters
string or null

Returned only when a JST is fetched using fetch/JST/{id} and fetch/JST endpoints. Use the admin.fetchjst endpoint to fetch the JSTs without possibly large calculationsResults, parameters and messages fields.

status
string <= 255 characters
Possible values: "WAITING_FOR_DISPATCH" "QUEUED_FOR_EXECUTION" "PROCESSING" "FAILED" "FINISHED" "CANCELLED" "INTERRUPTED"
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "priority": 0
}
Response samples
application/json
{
  • "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": {
          },
        • "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
    }
}