word (required)

string

A string to search for. You can specify some text or a ZQL query (in the latter case, you will have to specify zql=true in the request URL). For example:

• Text: any text

• ZQL query: creator="test.manager" and priority="P1"

entitytype (required)

string

The type of the entity to search for. Possible values:

• requirement

• testcase

• execution

releaseid (required)

long

The ID of the release the entity belongs to. To see the release ID in Zephyr, click Manage Release in the top-right corner and take a look at the value of the ID column in the subsequent window:

zql (required)

boolean

Specifies whether ZQL is used. false by default. Set it to true if the word parameter contains a ZQL query.

isascorder (optional)

boolean

Switches the ascending order. Specify true to sort the results in the ascending order or false to sort them in the descending order. By default, it is true.

order (optional)

string

The field to sort data by (this can be either a standard or a custom field). For example: testcaseId, automated, priority, creatorId, orderId and so on. Click here to refer to the Supported fields list.
The default parameter value is orderId. If you specify a custom field, you will also have to set the is_cfield parameter to true (see below).

firstresult (required)

integer

The first element of the retrieved results. The parameter is zero-based, which means you need to specify 0 as the start position to begin with the first element.

maxresults (required)

integer

The number of records to be fetched. The maximum number is 50000100.

is_cfield (optional)

boolean

If the order parameter specifies a custom field, set is_cfield to true. By default, it is false.