API for Search

Search Requirement/Test Case/Test Suite/Issue

POST /rest/search

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
bodybodyno
-string
entityTypebodyyesAbbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched-string
startbodynoStart index of records-integer
limitbodynoNumber of records per page-integer
pagebodynoPage number to be displayed-integer
valuebodyyesValue that need to search-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Blank search will return all entitiesResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-


Search Requirement/Test Suite/Issue [Deprecated]

POST /rest/search/result

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
entityTypebodyyesAbbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched-string
startbodynoStart index of records-integer
limitbodynoNumber of records per page-integer
pagebodynoPage number to be displayed-integer
scopebodyyesLevel('project'/'release'/'cycle') at which search is to be performed-string
filtersbodyyesfilters-Array[SearchFilters]
bodybodyno
-string
showAllStateEntitiesbody

yes

(only if entityType=TC)

If set "True", then will search across test cases irrespective of their Status (Approved or Not Approved).

If set "False", then will search across test cases having only "Approved" Status.

Falseboolean

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Blank search will return all entitiesResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-


Search Test Case  [Deprecated]

POST /rest/search/result

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
entityTypebodyyesAbbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched-string
startbodynoStart index of records-integer
limitbodynoNumber of records per page-integer
pagebodynoPage number to be displayed-integer
scopebodyyesLevel('project'/'release'/'cycle') at which search is to be performed-string
filterbodyyesfilter-Array[Filter]
bodybodyno
-string
showAllStateEntitiesbody

yes

(only if entityType=TC)

If set "True", then will search across test cases irrespective of their Status (Approved or Not Approved).

If set "False", then will search across test cases having only "Approved" Status.

Falseboolean

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Blank search will return all entitiesResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-



Definitions


ResponseEntity
nametyperequireddescriptionexample
headersobjectoptional-
bodyobjectoptional-
statusCodestringoptional-
Filters
nametyperequireddescriptionexample
namestringrequired-
opstringrequired-
valuestringrequired-
rawValuestringoptional-


SearchFilters
nametyperequireddescriptionexample
namestringrequiredName of Filter, send 'Match' to search
valuestringrequiredvalue to search, send 'OR' as the condition
rawValuestringrequiredraw value to search, send 'All'
filtersarray[API for Search#Filters]requiredFilter for entityKeyId,entityKey,name,description
Filter
nametyperequireddescriptionexample
valueobjectrequiredValue to search based on type of filter
typestringrequiredType of Filter
fieldstringrequiredField name on which filter is to be applied