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 unredacted result is returned.

Type: object

Call parameters

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:

{ "relationships": true, "extend": null, "extend_fk": [], "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

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

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

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

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

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

get

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

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.

limit

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.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• CoreGetJobsItemQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

CoreGetJobsItemQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

message_ids

Message Ids

Type: array
No Additional Items

Each item of this array must be:

Type: object

method

Method

Type: string

arguments

Arguments

Type: array
No Additional Items

Each item of this array must be:

Type: object

transient

Transient

Type: boolean

description

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

abortable

Abortable

Type: boolean

logs_path

Logs Path

Any of

• Option 1
• Option 2

Type: string

Type: null

logs_excerpt

Logs Excerpt

Any of

• Option 1
• Option 2

Type: string

Type: null

progress

CoreGetJobsItemProgress

Type: object
No Additional Properties

percent Required

Percent

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

extra Required

Extra

Type: object

result

Result

Type: object

result_encoding_error

Result Encoding Error

Type: object

error

Error

Any of

• Option 1
• Option 2

Type: string

Type: null

exception

Exception

Any of

• Option 1
• Option 2

Type: string

Type: null

exc_info

Any of

• CoreGetJobsItemExcInfo
• Option 2

CoreGetJobsItemExcInfo

Type: object
No Additional Properties

repr Required

Repr

Any of

• Option 1
• Option 2

Type: string

Type: null

type Required

Type

Any of

• Option 1
• Option 2

Type: string

Type: null

errno Required

Errno

Any of

• Option 1
• Option 2

Type: integer

Type: null

extra Required

Extra

Type: object

Type: null

state

State

Type: string

time_started

Time Started

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

time_finished

Time Finished

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

credentials

Any of

• CoreGetJobsItemCredentials
• Option 2

CoreGetJobsItemCredentials

Type: object
No Additional Properties

type Required

Type

Type: string

data Required

Data

Type: object

Type: null

CoreGetJobsItemQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

message_ids

Message Ids

Type: array
No Additional Items

Each item of this array must be:

Type: object

method

Method

Type: string

arguments

Arguments

Type: array
No Additional Items

Each item of this array must be:

Type: object

transient

Transient

Type: boolean

description

Description

Any of

• Option 1
• Option 2

Type: string

Type: null

abortable

Abortable

Type: boolean

logs_path

Logs Path

Any of

• Option 1
• Option 2

Type: string

Type: null

logs_excerpt

Logs Excerpt

Any of

• Option 1
• Option 2

Type: string

Type: null

progress

Type: object

result

Result

Type: object

result_encoding_error

Result Encoding Error

Type: object

error

Error

Any of

• Option 1
• Option 2

Type: string

Type: null

exception

Exception

Any of

• Option 1
• Option 2

Type: string

Type: null

exc_info

Any of

• Option 1
• Option 2

Type: object

Type: null

state

State

Type: string

time_started

Time Started

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

time_finished

Time Finished

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

credentials

Any of

• Option 1
• Option 2

Type: object

Type: null

Type: integer

Required roles: