Submit a Data Change Request (async)

post/dcrmanager.submit/{id}/async

Asynchronously submits the specified Data Change Request (DCR). Returns the Job Status Tracker object (JST).

Use to submit large (set by asyncSubmitDCRThreshold via Advanced Configuration Options) DCRs to avoid system timeouts (180 seconds - AWS).
asyncSubmitDCRThreshold default is set 100. If the key does not exist, the submit is always synchronous.

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

id of the DCR to be submitted.

Request Body schema: application/json
object
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
{ }
Response samples
application/json
{
  • "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": {
          },
        • "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
    }
}