Search STEP analysis jobs

get

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

Returns a list of STEP analysis jobs.

A STEP analysis job computes a STEP analysis for a specific event based on existing analysis. STEP API jobs are identified as the STEP_TOOL job type.

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 propeties: endedAt, jobId, name, startedAt, status, type, userName

Property	Data Type	Comparison	List
`endedAt`	`YYYY-MM-DD`	`=`
`jobId`	`string`	`=`	`IN`
`name`	`string`	`=`
`startedAt`	`YYYY-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). See Response Pagination.

Supported propeties: 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