Search batch jobs

get

https://{host}/platform/batch/v1/jobs/

Returns a list of batch jobs.

A BATCH job is a platform job that defines a user-defined workflow. The Create Batch Job operation defines a workflow that consists of multiple operations, which are managed as tasks within the BATCH job.

To learn more about managing and tracking jobs, see Platform Jobs.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators.

Query Params

filter

string

Query string to select response data based on property values. Supported properties: endedAt, jobId, name, startedAt, status, type, userName Depending on the property, you may use comparison operators, list operators, and logical operators.

Property	Data Type	Comparison	List
`endedAt`	`YYY-MM-DD`	`=`
`jobId`	`string`	`=`	`IN`
`name`	`string`	`=`
`startedAt`	`YYY-MM-DD`	`=`
`status`	`string`	`=`
`type`	`string`	`=`
`userName`	`string`	`=`

See Filtering Responses.

sort

string

Comma-delimited list of properties. Sort order defined by one of ASC (ascending) or DESC (descending).

Supported properties: endedAt, jobId, name, startedAt, status, type

limit

int32

Number of records to display per page.

offSet

int32

Number of the page displaying the returned records, starting at 0.

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error