Back to QMetry All Products Help Page
API for Project, Release, Cycle, Build, Platforms
- Mrunalini Potnis
- 1 Get Info Service
- 2 Get List of All Projects
- 3 Get List of Releases and Cycles and their metadata
- 4 Create Project
- 5 Clone Project
- 6 Archive Project
- 7 Delete Project
- 8 Unarchive Project
- 9 List of Releases
- 10 Create Release
- 11 Archive Release
- 12 Delete Release
- 13 Unarchive Release
- 14 List of Cycles
- 15 Create Cycle
- 16 Update Cycle
- 17 Archive Cycle
- 18 Delete Cycle
- 19 Unarchive Cycle
- 20 List of Build
- 21 Get Details of Build
- 22 Create Build
- 23 Archive Builds
- 24 Unarchive Build
- 25 List of Platforms
- 26 Create Platform
- 27 Unlink Platforms from Test Suites
Get Info Service
GET /rest/admin/project/getinfo
Description
This API returns all the information of the project like scope, types of -bugs, license details, etc.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
apiKey | header | yes | apiKey | - | string |
orgCode | header | yes | orgCode | - | string |
scope | header | yes | scope | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Successful operation. | |
400 | Returned if no project exists or project/release/cycle is archived | - |
500 | Returned if there is an error in server | - |
Get List of All Projects
POST /rest/admin/project/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
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 |
params | body | yes | Parameters | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of projects shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get List of Releases and Cycles and their metadata
POST /rest/admin/scope/tree
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
currentProjectFlag | body | no | Send true when project whose releases meta-data is to be fetched is same as the project in context | - | boolean |
showArchive | body | no | Send false to get only unarchived Releases, defaulted to false | - | boolean |
qmProjectID | body | yes | Unique identifier of project whose data is to be obtained | - | integer |
Response
Content-Type: application/json