Run a Calculation

post/calculationrecord.calculateset

Starts the calculation job (JST) of the calculation set. Returns the JobStatusTracker object.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
object
version
integer
typedId
string
label
string
compensationRecordSetId
integer
compensationRecordSetLabel
string
object
feederInputParams
Array of objects
inputParams
Array of objects
mappingParams
Array of objects
outputElements
Array of objects
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
status
string
isDefault
boolean
incremental
boolean
shouldSubmit
boolean
valid
boolean
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
{
  • "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
    }
}
Response samples
application/json
{
  • "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": {
          },
        • "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
    }
}