Run Search

get

https://{serverUrl}/app/components/task/app/api/v2/runs

Search Runs

Query Params

count

boolean

enum

Optional parameter. When not present, both the records and count that match the criteria will be returned. When present and set to "true", suppress the records and only return the count that matches the criteria. When present and set to "false", suppress the count and return the records that match the query along with the more property to indicate if more records match the criteria.

Allowed:

int32

Optional Id of the run to search for. If this parameter is used, all others are ignored.

afterId

int32

Optional, search for runs that have an Id greater than this value.

beforeId

int32

Optional, search for runs that have an Id less than this value.

start

date

UTC formatted timestamp to use as the starting date for the createdAt field. This value is inclusive in the results (>=).

Format: `yyyy-MM-dd`
    Example: 2017-07-27

Format: `yyyy-MM-dd'T'HH:mm:ssZ`
    Example: 2017-07-27T15:00:00Z

end

date

UTC formatted timestamp to use as the ending date for the createdAt field. This value is excluded in the results (<).

Format: `yyyy-MM-dd`
    Example: 2017-07-27

Format: `yyyy-MM-dd'T'HH:mm:ssZ`
    Example: 2017-07-27T15:00:00Z

includeSystem

string

enum

Optional whether to include system runs (Source: Kinetic Task). Ignored if the source parameter is also provided.

Allowed:

source

string

Optional name of the source the runs belong to.

sourceId

string

Optional sourceId

group

string

Optional source group (exact match)

groupFragment

string

Optional source group (matches any part of the source group - like match)

tree

string

Optional tree name (exact match)

treeFragment

string

Optional tree name (matches any part of the tree name - like match)

originatingId

int32

Optional Id of the originating run.

parentId

int32

Optional Id of the parent run.

status

string

enum

Optional status of the runs.

Allowed:

treeId

int32

Optional Id of the tree.

treeType

string

enum

Optional runs that belong to the specified type of tree / routine.

Allowed:

limit

int32

Defaults to 100

Number of results to limit the search to. Ignored if the count parameter is also provided.

offset

int32

Defaults to 0

Offset beginning for paginated results. Ignored if the count parameter is also provided.

orderBy

string

enum

Name of the field to order the results by. By default, the results are sorted descending by the id field.

include

array of strings

include

Response

200OK