ServiceJobRuns

Deprecated (since maarg 4.4.0): Use admin/serviceJobs

list ServiceJobRun

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

jobNamestringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

jobRunIdstringOptional

userIdstringOptional

The user that initiated the job run

parametersstringOptional

resultsstringOptional

messagesstringOptional

hasErrorstringOptional

errorsstringOptional

hostAddressstringOptional

hostNamestringOptional

runThreadstringOptional

startTimestring · date-timeOptional

endTimestring · date-timeOptional

lastUpdatedStampstring · date-timeOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/serviceJobRuns/{jobName}

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/serviceJobRuns/{jobName} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "moqui.service.job.ServiceJobRun",
    "jobRunId": "text",
    "jobName": "text",
    "userId": "text",
    "parameters": "text",
    "results": "text",
    "messages": "text",
    "hasError": "text",
    "errors": "text",
    "hostAddress": "text",
    "hostName": "text",
    "runThread": "text",
    "startTime": "2025-12-16T06:00:07.079Z",
    "endTime": "2025-12-16T06:00:07.079Z",
    "lastUpdatedStamp": "2025-12-16T06:00:07.079Z"
  }
]

one ServiceJobRun

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

jobNamestringRequired

jobRunIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/serviceJobRuns/{jobName}/{jobRunId}

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/serviceJobRuns/{jobName}/{jobRunId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "moqui.service.job.ServiceJobRun",
  "jobRunId": "text",
  "jobName": "text",
  "userId": "text",
  "parameters": "text",
  "results": "text",
  "messages": "text",
  "hasError": "text",
  "errors": "text",
  "hostAddress": "text",
  "hostName": "text",
  "runThread": "text",
  "startTime": "2025-12-16T06:00:07.079Z",
  "endTime": "2025-12-16T06:00:07.079Z",
  "lastUpdatedStamp": "2025-12-16T06:00:07.079Z"
}

one ServiceJobRunLock

get

Runtime data for a scheduled ServiceJob (with a cronExpression), managed automatically by the service job runner.

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

jobNamestringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/serviceJobRuns/{jobName}/activeJobRun

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/serviceJobRuns/{jobName}/activeJobRun HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "moqui.service.job.ServiceJobRunLock",
  "jobName": "text",
  "jobRunId": "text",
  "lastRunTime": "2025-12-16T06:00:07.079Z",
  "lastUpdatedStamp": "2025-12-16T06:00:07.079Z"
}