jobQueueEntry resource type

Represents a job queue entry in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET jobQueueEntryjobQueueEntryGets a job queue entry object.

Bound actions

The jobQueueEntry resource type offers a bound action called restart which restarts the corresponding jobQueueEntry batch. This is illustrated in the following example: RESTART https://<server address>:<server API port>/<server instance name>/api/v2.0/companies({id})/jobQueueEntrys({id})/Microsoft.NAV.restart

The response has no content; the response code is 204.

NavigationReturn TypeDescription
jobQueueLogEntriesjobQueueLogEntriesGets the jobqueuelogentries of the jobQueueEntry.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the job queue entry. Non-editable.
jobQueueEntryIdGUID
userIdstring
lastReadyStatedatetime
expirationDateTimedatetimeDate and time for when the webhook will expire.
earliestStartDateTimedatetime
objectTypeToRunstring
objectIdToRuninteger
objectCaptionToRunstring
reportOutputTypeNAV.jobQueueReportOutputType
maxNumberAttemptsToRuninteger
numberOfAttemptsToRuninteger
statusstringSpecifies the status of the job queue entry.
recordIdToProcessstring
parameterStringstring
recurringJobboolean
numberOfMinutesBetweenRunsinteger
runOnMondayboolean
runOnTuesdayboolean
runOnWednesdayboolean
runOnThursdayboolean
runOnFridaysboolean
runOnSaturdaysboolean
runOnSundaysboolean
startingTimestring
endingTimestring
referenceStartingTimedatetime
nextRunDateFormulastring
descriptionstringSpecifies the description of the job queue entry.
runInUserSessionboolean
userSessionIdinteger
jobQueueCategoryCodestring
errorMessagestringThe error message provided when a fail occurs.
userServiceInstanceIdinteger
userSessionStarteddatetime
notifyOnSuccessboolean
userLanguageIdinteger
printerNamestring
reportRequestPageOptionsboolean
rerunDelayinteger
systemTaskIdGUID
scheduledboolean
manualRecurrenceboolean
jobTimeOutstring
priorityWithinCategoryNAV.jobQueuePriority
lastModifiedDateTimedatetimeThe last datetime the job queue entry was modified. Read-Only.

JSON representation

Here's a JSON representation of the jobQueueEntry resource.

{
    "id": "GUID",
    "jobQueueEntryId": "GUID",
    "userId": "string",
    "lastReadyState": "datetime",
    "expirationDateTime": "datetime",
    "earliestStartDateTime": "datetime",
    "objectTypeToRun": "string",
    "objectIdToRun": "integer",
    "objectCaptionToRun": "string",
    "reportOutputType": "NAV.jobQueueReportOutputType",
    "maxNumberAttemptsToRun": "integer",
    "numberOfAttemptsToRun": "integer",
    "status": "string",
    "recordIdToProcess": "string",
    "parameterString": "string",
    "recurringJob": "boolean",
    "numberOfMinutesBetweenRuns": "integer",
    "runOnMonday": "boolean",
    "runOnTuesday": "boolean",
    "runOnWednesday": "boolean",
    "runOnThursday": "boolean",
    "runOnFridays": "boolean",
    "runOnSaturdays": "boolean",
    "runOnSundays": "boolean",
    "startingTime": "string",
    "endingTime": "string",
    "referenceStartingTime": "datetime",
    "nextRunDateFormula": "string",
    "description": "string",
    "runInUserSession": "boolean",
    "userSessionId": "integer",
    "jobQueueCategoryCode": "string",
    "errorMessage": "string",
    "userServiceInstanceId": "integer",
    "userSessionStarted": "datetime",
    "notifyOnSuccess": "boolean",
    "userLanguageId": "integer",
    "printerName": "string",
    "reportRequestPageOptions": "boolean",
    "rerunDelay": "integer",
    "systemTaskId": "GUID",
    "scheduled": "boolean",
    "manualRecurrence": "boolean",
    "jobTimeOut": "string",
    "priorityWithinCategory": "NAV.jobQueuePriority",
    "lastModifiedDateTime": "datetime"
}

GET jobQueueEntry