v1

latestOpenAPI 3.1.02026-07-24145580597.0 KB
Jobs:v1:Jobs

Get jobs

Get a list of job objects relevant to instance id (scheduler id or time clock id). If unified jobs are disabled, only schedulers are supported

get/jobs/v1/jobs

Query parameters

instanceIdsinteger[] nullable

List of instance IDs (schedule id or time clock id) to filter by

List of instance IDs (schedule id or time clock id) to filter by

jobIdsstring[] nullable

List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint

List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint

jobNamesstring[] nullable

List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

jobCodesstring[] nullable

List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

includeDeletedboolean

Determines whether the response includes jobs that have been deleted. Default value is set to true.

Determines whether the response includes jobs that have been deleted. Default value is set to true.

sort'title'

Sort key

order'asc' | 'desc'

Sort order, set only if sort key is set

limitinteger

The maximum number of results to display per page

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring