获取列表

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

logId

string

Filter by historic job log id.

jobId

string

Filter by job id.

jobExceptionMessage

string

Filter by job exception message.

jobDefinitionId

string

Filter by job definition id.

jobDefinitionType

string

Filter by job definition type. See the User Guide for more information about job definition types.

jobDefinitionConfiguration

string

Filter by job definition configuration.

activityIdIn

string

Only include historic job logs which belong to one of the passed activity ids.

failedActivityIdIn

string

Only include historic job logs which belong to failures of one of the passed activity ids.

executionIdIn

string

Only include historic job logs which belong to one of the passed execution ids.

processInstanceId

string

Filter by process instance id.

processDefinitionId

string

Filter by process definition id.

processDefinitionKey

string

Filter by process definition key.

deploymentId

string

Filter by deployment id.

tenantIdIn

string

Only include historic job log entries which belong to one of the passed and comma- separated tenant ids.

withoutTenantId

boolean

Only include historic job log entries that belong to no tenant. Value may only be true, as false is the default behavior.

hostname

string

Filter by hostname.

jobPriorityLowerThanOrEquals

integer

Only include logs for which the associated job had a priority lower than or equal to the given value. Value must be a valid long value.

jobPriorityHigherThanOrEquals

integer

Only include logs for which the associated job had a priority higher than or equal to the given value. Value must be a valid long value.

creationLog

boolean

Only include creation logs. Value may only be true, as false is the default behavior.

failureLog

boolean

Only include failure logs. Value may only be true, as false is the default behavior.

successLog

boolean

Only include success logs. Value may only be true, as false is the default behavior.

deletionLog

boolean

Only include deletion logs. Value may only be true, as false is the default behavior.

sortBy

enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:

timestamp,

jobId,

jobDefinitionId,

jobDueDate,

jobRetries,

jobPriority,

activityId,

executionId,

processInstanceId,

processDefinitionId,

processDefinitionKey,

deploymentId,

hostname,

occurrence,

tenantId

sortOrder

enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:

asc,

desc

firstResult

integer

Pagination of results. Specifies the index of the first result to return.

maxResults

integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

string | null

The id of the log entry.

timestamp

string<date-time> | null

The time when the log entry has been written.

removalTime

string<date-time> | null

The time after which the log entry should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ. For further info see the docs

jobId

string | null

The id of the associated job.

jobDueDate

string<date-time> | null

The date on which the associated job is supposed to be processed.

jobRetries

integer | null

The number of retries the associated job has left.

jobPriority

integer | null

The execution priority the job had when the log entry was created.

jobExceptionMessage

string | null

The message of the exception that occurred by executing the associated job.

failedActivityId

string | null

The id of the activity on which the last exception occurred by executing the associated job.

jobDefinitionId

string | null

The id of the job definition on which the associated job was created.

jobDefinitionType

string | null

The job definition type of the associated job. See the User Guide for more information about job definition types.

jobDefinitionConfiguration

string | null

The job definition configuration type of the associated job.

activityId

string | null

The id of the activity on which the associated job was created.

executionId

string | null

The execution id on which the associated job was created.

processInstanceId

string | null

The id of the process instance on which the associated job was created.

processDefinitionId

string | null

The id of the process definition which the associated job belongs to.

processDefinitionKey

string | null

The key of the process definition which the associated job belongs to.

deploymentId

string | null

The id of the deployment which the associated job belongs to.

rootProcessInstanceId

string | null

The process instance id of the root process instance that initiated the process which the associated job belongs to.

tenantId

string | null

The id of the tenant that this historic job log entry belongs to.

hostname

string | null

The name of the host of the Process Engine where the job of this historic job log entry was executed.

batchId

string | null

The ID of the batch associated with this job. null if no batch is associated with this job. The following jobs are associated with batches:

Seed Jobs
Monitor Jobs
Batch Execution Jobs

creationLog

boolean | null

A flag indicating whether this log represents the creation of the associated job.

failureLog

boolean | null

A flag indicating whether this log represents the failed execution of the associated job.

successLog

boolean | null

A flag indicating whether this log represents the successful execution of the associated job.

deletionLog

boolean | null

A flag indicating whether this log represents the deletion of the associated job.

REST API

Javadoc

Authorizations

Query Parameters

Response