Search Entities

API to Search Entities

POST /rest/search

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

body

body

No


-

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 to be searched

-

string

entityType

body

Yes

* Abbreviated EntityType('RQ'/'TC'/'TS'/'IS') whose entities are to be searched

-

string

* Entity wise parameters are described below.

Search Test Cases

API to search test cases (Search Test Cases parameters are part of the main Search Entities.)

Name

Located in

Required

Description

Default

Schema

entityType

body

Yes

For Testcase entity type would be - TC

-

string

showAllStateEntities

body

No

  • If eSignature is enabled for the project - Send 'true' to get data of all states and 'false' to get only approved entities.

  • If eSignature is disabled for the project - Send 'true' to get data of all states and 'false' would not get any data.

-

boolean

folderPath

body

No

Path to the root folder of testcase

-

string

Search Issues

API to search issues (Search Issues parameters are part of the main Search Entities.)

Name

Located in

Required

Description

Default

Schema

entityType

body

Yes

For Testcase entity type would be - IS

-

string

Search Requirements

API to search requirements (Search Requirements parameters are part of the main Search Entities.)

Name

Located in

Required

Description

Default

Schema

entityType

body

Yes

For Testcase entity type would be - RQ

-

string

Search Test Suites

API to search test suites (Search Test Suites parameters are part of the main Search Entities.)

Name

Located in

Required

Description

Default

Schema

entityType

body

Yes

For Testcase entity type would be - TS

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Blank search will return all entities

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

ResponseEntityString

name

type

required

description

example

headers

object

optional

-


body

string

optional

-


statusCode

string

optional

-


statusCodeValue

integer

optional

-