This API returns all the information of the project like scope, types of -bugs, license details, etc.
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
project | header | yes | Project or scope Id/Key/Name | - | string |
apiKey | header | yes | Open API key generated in Integration > Open API in QTM. | - | string |
Content-Type | header | yes | Enter value “application/json”. | - | string |
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 | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
start | body | yes | Start index of records | - | integer |
limit | body | yes | Number of records per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
params | body | yes | Parameters | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | List of projects shown successfully | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
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 |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Release meta-data fetched successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
project | body | yes | Check project parameters | - | |
release | body | yes | Check release parameters | - | |
cycle | body | yes | Check cycle parameters | - | |
addLdapUser | body | yes | Set true to allow addition of LDAP users in the project | - | boolean |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Project successfully added | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
API to clone project
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
Projectkey | body | yes | The unique project key of new project | - | string |
clone | body | yes | Type of clone:- 0 - to clone only the folder structure, along with any releases and cycles & 1 - to clone Project meta-data, Requirements, Test Cases, Test Suites and Issues | - | string |
name | body | yes | Name of the project to be cloned | - | string |
newProject | body | yes | Name of the new project | - | string |
projectID | body | yes | The unique identifier by which to identify the cloned project. | - | string |
apiKey | header | yes | Open API key generated in Integration > Open API in QTM. | - | string |
scope | header | yes | Project or scope Id/Key/Name | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Project clone initiated | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
projectID | body | yes | Unique identifier of projects to archive | - | Array[integer] |
apiKey | header | yes | Open API key generated in Integration > Open API in QTM. | - | string |
scope | header | yes | Project or scope Id/Key/Name | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Project successfully archived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
projectID | body | yes | Unique identifier of project to delete | - | integer |
apiKey | header | yes | Open API key generated in Integration > Open API in QTM. | - | string |
scope | header | yes | Project or scope Id/Key/Name | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Project deletion has been initialized | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorized or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
projectID | body | yes | Unique identifier of projects to unarchive | - | Array[integer] |
apiKey | header | yes | Open API key generated in Integration > Open API in QTM. | - | string |
scope | header | yes | Project or scope Id/Key/Name | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Project successfully unarchived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
start | body | yes | Start index of records | - | integer |
limit | body | yes | Number of records per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
params | body | yes | Parameters | - | |
sort | body | yes | Sort Parameters | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | List of releases shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
releaseParams | body | yes | Release Parameters | - | |
cycle | body | yes | Cycle Parameters | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Release created successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
releaseID | body | yes | Id of release to archive | - | Array[integer] |
projectID | body | yes | Id of project to which the release belongs | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Release successfully archived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
releaseID | body | yes | Id of release to delete | - | Array[integer] |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Release successfully deleted | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
releaseID | body | yes | Id of release to unarchive | - | Array[integer] |
projectID | body | yes | Id of project to which the release belongs | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Release successfully unarchived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out |
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 | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | List of cycles shown successfully | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
cycle | body | yes | provide cycle | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Cycle created successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
cycle | body | yes | check CycleParams | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Cycle updated successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
buildID | body | yes | Id of cycle to archive | - | Array[integer] |
releaseID | body | yes | Id of release to which the cycle belongs | - | integer |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Cycle successfully archived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
buildID | body | yes | Id of cycle to delete | - | Array[integer] |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Cycle successfully deleted | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
API to unarchive cycle of release in the project
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
buildID | body | yes | Id of cycle to unarchive | - | Array[integer] |
releaseID | body | yes | Id of Release to which the cycle belongs | - | integer |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Cycle successfully unarchived | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
List of all builds in the project
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
start | body | yes | Start index of records | - | integer |
limit | body | yes | Number of records per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
showArchive | body | yes | Send 'true' to display archived Builds as well | - | boolean |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | List of build | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
jsonbody | body | yes | Unique identifier of build to get its details | - | string |
id | body | yes | Unique identifier of build to get its details | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Details of build shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
dropID | body | yes | Unique ID of build | - | string |
name | body | yes | Name of Build | - | string |
Description | body | yes | Description of Build | - | string |
Defaultroleid | body | yes | Default roleID of Build | - | Arrays |
chkDrop | body | yes | true if checkBuild | - | Arrays |
grdRelCyc | body | yes | Add Release Cycle to the Build | - | Array[GrdRelCyc] |
body | body | no | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Build created successfully. | ResponseEntityString |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
dropIds | body | yes | Id of builds to archive | - | Array[integer] |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Builds archived successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
dropIds | body | yes | Id of builds to unarchive | - | Array[integer] |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Builds unarchived successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
start | body | yes | Start index of records | - | integer |
limit | body | yes | Number of records per page | - | integer |
page | body | yes | Page number to be displayed | - | integer |
sort | body | no | Sort parameters | - |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | List of platforms shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
name | body | yes | Name of Platform | - | string |
platformID | body | yes | Send '0' to create a new Platform | - | integer |
platformType | body | yes | Send 'single' to add new Platform | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Platform created successfully. | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
---|---|---|---|---|---|
qmTsId | body | yes | Id of Test Suites | - | integer |
platformID | body | yes | Comma-separated value of platformId of Platform | - | string |
Content-Type: application/json
Status Code | Reason | Response Model |
---|---|---|
200 | Platforms successfully unlinked to testsuite | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
name | type | required | description | example |
---|---|---|---|---|
headers | object | optional | - | |
body | object | optional | - | |
statusCode | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Cycle | |
isLocked | boolean | optional | Defaulted to false | |
isArchived | boolean | optional | Defaulted to false |
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Cycle | |
startDate | string | optional | To set StartDate of cycle | |
targetDate | string | optional | To set TargetDate of cycle | |
projectID | string | required | Unique identifier of project in which the cycle is to be added | |
releaseID | integer | required | Unique identifier of release in which the cycle is to be added |
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Cycle | |
startDate | string | optional | To set StartDate of cycle | |
targetDate | string | optional | To set TargetDate of cycle | |
buildID | string | required | Unique identifier of cycle to update | |
releaseID | integer | required | Unique identifier of release under which the cycle is created |
name | type | required | description | example |
---|---|---|---|---|
name | string | optional | - | |
scope | string | optional | - | |
cyclID | integer | optional | - | |
relID | integer | optional | - | |
default | string | optional | - |
name | type | required | description | example |
---|---|---|---|---|
isAutoAddValue | boolean | optional | Defaulted to true | |
approvalWorkflow | boolean | optional | Defaulted to true. Set true to enable eSignature in the project | |
name | string | required | Name of the new project | |
projectKey | string | required | Unique key to identify the new project | |
addLdapUser | boolean | optional | Set true to allow addition of LDAP users in the project |
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Release | |
description | string | required | An explanation for the release. |
name | type | required | description | example |
---|---|---|---|---|
name | string | required | Name of Release | |
startDate | string | required | Start date of the Release | |
targetDate | string | required | Target date of the Release | |
projectID | string | required | ID of project in which the Release resides |
name | type | required | description | example |
---|---|---|---|---|
releaseID | integer | optional | - | |
showArchive | boolean | optional | - |
name | type | required | description | example |
---|---|---|---|---|
showArchive | boolean | required | Send 'true' to show archived entities |
name | type | required | description | example |
---|---|---|---|---|
property | string | required | property based on which sorting is to be applied | |
direction | string | required | Direction of sort - 'ASC'/'DESC' |
name | type | required | description | example |
---|---|---|---|---|
projectID | string | required | Unique identifier of project |
name | type | required | description | example |
---|---|---|---|---|
headers | object | optional | - | |
body | string | optional | - | |
statusCode | string | optional | - | |
statusCodeValue | integer | optional | - |