AdminGetBatchParams

Parameters used to filter and configure pagination of the retrieved batch jobs.

Properties

limitnumberRequired

Limit the number of items returned in the list.

Default: 10

offsetnumberRequired

The number of items to skip when retrieving a list.

Default: 0

expandstring

Comma-separated relations that should be expanded in the returned data.

fieldsstring

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

orderstring

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

idstring | string[]

IDs to filter batch jobs by.

typestring[]

Types to filter batch jobs by.

confirmed_atnull | DateComparisonOperator

Date filters to apply on the batch jobs' confirmed_at date.

pre_processed_atnull | DateComparisonOperator

Date filters to apply on the batch jobs' pre_processed_at date.

completed_atnull | DateComparisonOperator

Date filters to apply on the batch jobs' completed_at date.

failed_atnull | DateComparisonOperator

Date filters to apply on the batch jobs' failed_at date.

canceled_atnull | DateComparisonOperator

Date filters to apply on the batch jobs' canceled_at date.

created_atDateComparisonOperator

Date filters to apply on the batch jobs' created_at date.

updated_atDateComparisonOperator

Date filters to apply on the batch jobs' updated_at date.