core.get_jobs

Updates on job changes.

Type: object

ADDED

CoreGetJobsAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

ID of the job that was added.

fields Required

CoreGetJobsItem

Type: object

Complete job information for the newly added job.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for this job.

message_ids Required

Message Ids

Type: array

Array of message IDs associated with this job.

No Additional Items

Each item of this array must be:

Type: object

method Required

Method

Type: string

Name of the method/service being executed by this job.

arguments Required

Arguments

Type: array

Array of arguments passed to the job method.

No Additional Items

Each item of this array must be:

Type: object

transient Required

Transient

Type: boolean

Whether this is a temporary job that will be automatically cleaned up.

description Required

Description

Human-readable description of what this job does. null if not provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

abortable Required

Abortable

Type: boolean

Whether this job can be cancelled/aborted.

logs_path Required

Logs Path

File system path to detailed job logs. null if no logs available.

Any of

• Option 1
• Option 2

Type: string

Type: null

logs_excerpt Required

Logs Excerpt

Brief excerpt from job logs for quick preview. null if no logs available.

Any of

• Option 1
• Option 2

Type: string

Type: null

progress Required

CoreGetJobsItemProgress

Type: object

Current progress information for the job.

No Additional Properties

percent Required

Percent

Completion percentage of the job. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Human-readable description of the current progress. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

extra Required

Extra

Type: object

Additional progress information specific to the job type.

result Required

Result

Type: object

The result data returned by the job upon successful completion.

result_encoding_error Required

Result Encoding Error

Type: object

Encoding error information if result serialization failed.

error Required

Error

Error message if the job failed. null if no error occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

exception Required

Exception

Exception details if the job encountered an exception. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

exc_info Required

Detailed exception information. null if no exception occurred.

Any of

• CoreGetJobsItemExcInfo
• Option 2

CoreGetJobsItemExcInfo

Type: object
No Additional Properties

repr Required

Repr

String representation of the exception. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Exception type name. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

errno Required

Errno

System error number if applicable. null otherwise.

Any of

• Option 1
• Option 2

Type: integer

Type: null

extra Required

Extra

Type: object

Additional exception information.

Type: null

state Required

State

Type: string

Current execution state of the job.

Examples:

"WAITING"

"RUNNING"

"SUCCESS"

"FAILED"

"ABORTED"

time_started Required

Time Started

Timestamp when the job started execution. null if not yet started.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

time_finished Required

Time Finished

Timestamp when the job completed execution. null if still running or not started.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

credentials Required

Authentication credentials used for this job. null if no authentication required.

Any of

• CoreGetJobsItemCredentials
• Option 2

CoreGetJobsItemCredentials

Type: object
No Additional Properties

type Required

Type

Type: string

Authentication type used for the job.

data Required

Data

Type: object

Authentication data and credentials for the job.

Type: null

CHANGED

CoreGetJobsChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

ID of the job that was updated.

fields Required

CoreGetJobsItem

Type: object

Updated job information with changes.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for this job.

message_ids Required

Message Ids

Type: array

Array of message IDs associated with this job.

No Additional Items

Each item of this array must be:

Type: object

method Required

Method

Type: string

Name of the method/service being executed by this job.

arguments Required

Arguments

Type: array

Array of arguments passed to the job method.

No Additional Items

Each item of this array must be:

Type: object

transient Required

Transient

Type: boolean

Whether this is a temporary job that will be automatically cleaned up.

description Required

Description

Human-readable description of what this job does. null if not provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

abortable Required

Abortable

Type: boolean

Whether this job can be cancelled/aborted.

logs_path Required

Logs Path

File system path to detailed job logs. null if no logs available.

Any of

• Option 1
• Option 2

Type: string

Type: null

logs_excerpt Required

Logs Excerpt

Brief excerpt from job logs for quick preview. null if no logs available.

Any of

• Option 1
• Option 2

Type: string

Type: null

progress Required

CoreGetJobsItemProgress

Type: object

Current progress information for the job.

No Additional Properties

percent Required

Percent

Completion percentage of the job. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Human-readable description of the current progress. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

extra Required

Extra

Type: object

Additional progress information specific to the job type.

result Required

Result

Type: object

The result data returned by the job upon successful completion.

result_encoding_error Required

Result Encoding Error

Type: object

Encoding error information if result serialization failed.

error Required

Error

Error message if the job failed. null if no error occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

exception Required

Exception

Exception details if the job encountered an exception. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

exc_info Required

Detailed exception information. null if no exception occurred.

Any of

• CoreGetJobsItemExcInfo
• Option 2

CoreGetJobsItemExcInfo

Type: object
No Additional Properties

repr Required

Repr

String representation of the exception. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Exception type name. null if no exception occurred.

Any of

• Option 1
• Option 2

Type: string

Type: null

errno Required

Errno

System error number if applicable. null otherwise.

Any of

• Option 1
• Option 2

Type: integer

Type: null

extra Required

Extra

Type: object

Additional exception information.

Type: null

state Required

State

Type: string

Current execution state of the job.

Examples:

"WAITING"

"RUNNING"

"SUCCESS"

"FAILED"

"ABORTED"

time_started Required

Time Started

Timestamp when the job started execution. null if not yet started.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

time_finished Required

Time Finished

Timestamp when the job completed execution. null if still running or not started.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

credentials Required

Authentication credentials used for this job. null if no authentication required.

Any of

• CoreGetJobsItemCredentials
• Option 2

CoreGetJobsItemCredentials

Type: object
No Additional Properties

type Required

Type

Type: string

Authentication type used for the job.

data Required

Data

Type: object

Authentication data and credentials for the job.

Type: null

Required roles: