List Jobs

post/admin.fetchjst

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.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json

A general fetch request. A filter can be applied.

endRow
integer
oldValues
object or null
operationType
string
startRow
integer
textMatchStyle
string
object
_constructor
string
operator
string
Array of objects
Array
fieldName
string
operator
string
value
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
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
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "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"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "string",
    • "startRow": 0,
    • "data": [
      • {
        • "processingStart": "string",
        • "targetObject": "string",
        • "typedId": "string",
        • "lastUpdateDate": "2019-08-24T14:15:22Z",
        • "trackerType": "PRICELIST",
        • "threadId": 0,
        • "jobSettings": {
          },
        • "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
    }
}