# core.get_jobs

Get information about long-running jobs. If authenticated session does not have the FULL_ADMIN role, only jobs owned by the current authenticated session will be returned.

`result` key will have sensitive values redacted by default for external clients.

Redaction behavior may be explicitly specfied via the `extra` query option `raw_result`. If `raw_result` is `true` then an unredacted result is returned.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filters

#### filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

##### Each item of this array must be:

Type: object
Examples:

    [
        [
            "name",
            "=",
            "bob"
        ]
    ]

    [
        [
            "OR",
            [
                [
                    [
                        "name",
                        "=",
                        "bob"
                    ]
                ],
                [
                    [
                        "name",
                        "=",
                        "larry"
                    ]
                ]
            ]
        ]
    ]

##### Parameter 2: options

#### options

Type: object
Default:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the results list).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.` may be used to explicitly select only subkeys of the query result.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Value must be greater or equal to `0`

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

Value must be greater or equal to `0` and lesser or equal to `10000`

##

#### Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### CoreGetJobsItem

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for this job.

##

#### 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

Type: string

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

##

#### Arguments

Type: array

Array of arguments passed to the job method.

No Additional Items

##### Each item of this array must be:

Type: object

##

#### Transient

Type: boolean

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

##

#### Description

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Abortable

Type: boolean

Whether this job can be cancelled/aborted.

##

#### Logs Path

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

## Any of

Type: string
Type: null

##

#### Logs Excerpt

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### CoreGetJobsItemProgress

Type: object

Current progress information for the job.

No Additional Properties

##

#### Percent

Completion percentage of the job. `null` if not available.

## Any of

Type: integer
Type: null

##

#### Description

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Extra

Type: object

Additional progress information specific to the job type.

##

#### Result

Type: object

The result data returned by the job upon successful completion.

##

#### Result Encoding Error

Type: object

Encoding error information if result serialization failed.

##

#### Error

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Exception

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

Detailed exception information. `null` if no exception occurred.

## Any of

#### CoreGetJobsItemExcInfo

Type: object
No Additional Properties

##

#### Repr

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Type

Exception type name. `null` if no exception occurred.

## Any of

Type: string
Type: null

##

#### Errno

System error number if applicable. `null` otherwise.

## Any of

Type: integer
Type: null

##

#### Extra

Type: object

Additional exception information.

Type: null

##

#### State

Type: string

Current execution state of the job.

Examples:

    "WAITING"

    "RUNNING"

    "SUCCESS"

    "FAILED"

    "ABORTED"

##

#### Time Started

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

## Any of

Type: string Format: date-time
Type: null

##

#### Time Finished

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

## Any of

Type: string Format: date-time
Type: null

##

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

## Any of

#### CoreGetJobsItemCredentials

Type: object
No Additional Properties

##

#### Type

Type: string

Authentication type used for the job.

##

#### Data

Type: object

Authentication data and credentials for the job.

Type: null

#### CoreGetJobsItem

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for this job.

##

#### 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

Type: string

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

##

#### Arguments

Type: array

Array of arguments passed to the job method.

No Additional Items

##### Each item of this array must be:

Type: object

##

#### Transient

Type: boolean

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

##

#### Description

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Abortable

Type: boolean

Whether this job can be cancelled/aborted.

##

#### Logs Path

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

## Any of

Type: string
Type: null

##

#### Logs Excerpt

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

Type: object

Current progress information for the job.

##

#### Result

Type: object

The result data returned by the job upon successful completion.

##

#### Result Encoding Error

Type: object

Encoding error information if result serialization failed.

##

#### Error

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

#### Exception

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

## Any of

Type: string

Must be at most `2147483647` characters long

Type: null

##

Detailed exception information. `null` if no exception occurred.

## Any of

Type: object
Type: null

##

#### State

Type: string

Current execution state of the job.

Examples:

    "WAITING"

    "RUNNING"

    "SUCCESS"

    "FAILED"

    "ABORTED"

##

#### Time Started

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

## Any of

Type: string Format: date-time
Type: null

##

#### Time Finished

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

## Any of

Type: string Format: date-time
Type: null

##

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

## Any of

Type: object
Type: null
Type: array of object
No Additional Items

##### Each item of this array must be:

Type: object
Type: object
Type: integer

Required roles: