Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Value

Type

Description

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). For example:

  • test

  • project="Portfolio" and executionStatus=PASS

entitytype (required)

string

The type of the entity to search for.

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:

Image Added

zql (required)

boolean

Specifies whether ZQL is used.

isascorder (optional)

boolean

Switches the ascending order.

order (optional)

string

The column order. For example, the parameter value can be orderId: .../flex/services/rest/v3/advancesearch/?word=test&firstresult=0&maxresults=50&order=orderId&releaseid=1

firstresult (required)

integer

The starting point of the record.

maxresults (required)

integer

The number of records to be fetched.

is_cfield (optional)

boolean

Custom field order.

isOld (optional)

boolean

Specifies whether the test case is old.

...

Code Block
languagejson
[
   {
      "firstResult": 0,
      "resultSize": 1,
      "results": [
         {
            "id": 147,     ----------------------------------- The RTS ID (the execution ID)
            "assignmentDate": "2020-09-15",
            "actualTime": 600,
            "versionId": "1",
            "comment": "This is a comment",
            "testerId": 5,
            "executedBy": 5,
            "tcrTreeTestcase": {
               "id": 308,  ----------------------------------- The TCR Catalog Tree TestCase ID (tctid)
               "tcrCatalogTreeId": 30,
               "revision": 9,
               "stateFlag": 0,
               "lastModifiedOn": 1600168120466,
               "versionNumber": 1,
               "createDatetime": 1600168114777,
               "createdById": 5,
               "modifiedById": 5,
               "testcase": {
                  "customProperties": {
                  },
                  "customProcessedProperties": {
                  },
                  "id": 165, ----------------------------------- The test case version ID
                  "name": "edited 159 testcase edit",
                  "description": "",
                  "lastModifiedOn": 1600169396082,
                  "creationDate": 1600128000000,
                  "createDatetime": 1600168102437,
                  "tcCreationDate": "09/15/2020",
                  "comments": "",
                  "isComplex": false,
                  "estimatedTime": 600,
                  "writerId": 0,
                  "creatorId": 5,
                  "lastUpdaterId": 5,
                  "oldId": 0,
                  "automated": false,
                  "customFieldProcessed": false,
                  "customFieldValues": [
                     
                  ],
                  "testcaseSequence": {
                     "seqNumber": 159
                  },
                  "testcaseId": 159, ----------------------------------- The test case ID
                  "versionNumber": 1,
                  "projectId": 3,
                  "testcaseType": "ORIGINAL",
                  "requirementIds": [
                     
                  ],
                  "projectName": "P1",
                  "requirementIdsNew": [
                     
                  ],
                  "creatorName": "John Smith",
                  "lastModifierName": "John Smith",
                  "automatedDefault": false,
                  "testcaseShared": false
               },
               "projectId": 3,
               "releaseId": 5,
               "isDerivedFromBDD": false,
               "orderId": 453,
               "maxVersionNumber": 1,
               "projectIdParam": 3,
               "original": false
            },
            "cyclePhaseId": 7,
            "lastTestResult": {
               "id": 58,
               "executionDate": 1600169404251,
               "execDate": "09/15/2020",
               "executionStatus": "4",
               "testerId": 5,
               "releaseTestScheduleId": 147,
               "createDatetime": 1600169404253,
               "modifiedDatetime": 1600169404250,
               "createdById": 5,
               "modifiedById": 5
            },
            "defects": [
               
            ],
            "attachmentCount": 0,
            "lastModifiedBy": 5,
            "createdById": 5,
            "lastModifiedOn": 1600169404255,
            "createDatetime": 1600168120467
         }
      ],
      "type": "testSchedule"
   }
]

Response codes

...