Tree Search

get

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

Returns information about all triggers that match the search parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

source

string

Optional name of the source the trees belong to.

group

string

Optional group the trees belong to (exact match)

group[]

array of strings

Optional combination of groups the trees belong to (exact match)

group[]

groupFragment

string

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

name

string

Optional name of the trees (exact match)

nameFragment

string

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

ownerEmail

string

Optional the process owner's email address.

status

string

enum

Optional status of trees.

Allowed:

type

string

enum

Optional type of tree / routine to retrieve.

Allowed:

limit

int32

Defaults to 100

Limit the number of results to the specified value.

offset

int32

Defaults to 0

The row number of the first record to retrieve.

orderBy

string

enum

Name of the field to order the results by. By default, the results are sorted ascending by the following combination of fields - Source Name, Source Group, Name.

direction

string

enum

Defaults to ASC

Direction to order the results, ascending (ASC) or descending (DESC). Must also include the orderBy parameter when using this parameter.

Allowed:

include

array of strings

comma-separated list of additional properties to include in the response

include

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

200OK