API for Search
Search Requirement/Test Case/Test Suite/Issue
POST /rest/search
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
body | body | no | - | string | |
entityType | body | yes | Abbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched | - | string |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
value | body | yes | Value that need to search | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Blank search will return all entities | ResponseEntity |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Search Requirement/Test Suite/Issue [Deprecated]
POST /rest/search/result
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
entityType | body | yes | Abbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched | - | string |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
scope | body | yes | Level('project'/'release'/'cycle') at which search is to be performed | - | string |
filters | body | yes | filters | - | Array[SearchFilters] |
body | body | no | - | string | |
showAllStateEntities | body | 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. | False | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Blank search will return all entities | ResponseEntity |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Search Test Case [Deprecated]
POST /rest/search/result
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
entityType | body | yes | Abbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched | - | string |
start | body | no | Start index of records | - | integer |
limit | body | no | Number of records per page | - | integer |
page | body | no | Page number to be displayed | - | integer |
scope | body | yes | Level('project'/'release'/'cycle') at which search is to be performed | - | string |
filter | body | yes | filter | - | Array[Filter] |
body | body | no | - | string | |
showAllStateEntities | body | 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. | False | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Blank search will return all entities | ResponseEntity |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Definitions
ResponseEntity
name | type | required | description | example |
---|---|---|---|---|
headers | object | optional | - | |
body | object | optional | - | |
statusCode | string | optional | - |
Filters
name | type | required | description | example |
---|---|---|---|---|
name | string | required | - | |
op | string | required | - | |
value | string | required | - | |
rawValue | string | optional | - |
SearchFilters
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Filter, send 'Match' to search | |
value | string | required | value to search, send 'OR' as the condition | |
rawValue | string | required | raw value to search, send 'All' | |
filters | array[API for Search#Filters] | required | Filter for entityKeyId,entityKey,name,description |
Filter
name | type | required | description | example |
---|---|---|---|---|
value | object | required | Value to search based on type of filter | |
type | string | required | Type of Filter | |
field | string | required | Field name on which filter is to be applied |