API for Project, Release, Cycle, Build, Platforms

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

NameLocated inRequiredDescriptionDefaultSchema
usertokenheaderyesusertoken-string
orgCodeheaderyesorgCode-string
scopeheaderyesscope-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Successful operation.ResponseEntity
400Returned if no project exists or project/release/cycle is archived-
500Returned if there is an error in server-

Get List of All Projects

POST /rest/admin/project/list

Request

Content-Type: application/json

Parameters


NameLocated inRequiredDescriptionDefaultSchema
startbodynoStart index of records-integer
limitbodynoNumber of records per page-integer
pagebodynoPage number to be displayed-integer
paramsbodyyesParameters-Param2

Response

Content-Type: application/json

Status CodeReasonResponse Model
200List of projects shown successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned 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

NameLocated inRequiredDescriptionDefaultSchema
currentProjectFlagbodynoSend true when project whose releases meta-data is to be fetched is same as the project in context-boolean
showArchivebodynoSend false to get only unarchived Releases, defaulted to false-boolean
qmProjectIDbodyyesUnique identifier of project whose data is to be obtained-integer

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Release meta-data fetched successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Create Project

POST /rest/admin/project

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
projectbodyyesCheck project parameters-ProjectParameters
releasebodyyesCheck release parameters-ReleaseParams
cyclebodyyesCheck cycle parameters-Cycle
addLdapUserbodyyesSet true to allow addition of LDAP users in the project-boolean

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Project successfully addedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Clone Project

POST /rest/admin/project/clone

Description

API to clone project

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
ProjectkeybodyyesThe unique project key of new project-string
clonebodyyesType 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
namebodyyesName of the project to be cloned-string
newProjectbodyyesName of the new project-string
projectIDbodyyesThe unique identifier by which to identify the cloned project-string
apiKeyheaderyesapiKey-string
scopeheaderyesscope-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Project clone initiatedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Archive Project

PUT /rest/admin/project/archive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
projectIDbodyyesUnique identifier of projects to archive-Array[integer]
apiKeyheaderyesapiKey-string
scopeheaderyesscope-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Project successfully archivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Delete Project

PUT /rest/admin/project/delete

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
projectIDbodyyesUnique identifier of project to delete-integer
apiKeyheaderyesapiKey-string
scopeheaderyesscope-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Project deletion has been initialisedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorized or session expired-
500Returned when server connection times out-

Unarchive Project

PUT /rest/admin/project/unarchive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
projectIDbodyyesUnique identifier of projects to unarchive-Array[integer]
apiKeyheaderyesapiKey-string
scopeheaderyesscope-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Project successfully unarchivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

List of Releases

POST /rest/admin/release/list

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
startbodyyesStart index of records-integer
limitbodyyesNumber of records per page-integer
pagebodyyesPage number to be displayed-integer
paramsbodyyesParameters-Param4
sortbodyyesSort Parameters-Sort

Response

Content-Type: application/json

Status CodeReasonResponse Model
200List of releases shown successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Create Release

POST /rest/admin/release

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
releaseParamsbodyyesRelease Parameters-Release
cyclebodyyesCycle Parameters-Cycle

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Release created successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Archive Release

PUT /rest/admin/release/archive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
releaseIDbodyyesId of release to archive-Array[integer]
projectIDbodyyesId of project to which the release belongs-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Release successfully archivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Delete Release

POST /rest/admin/release/delete

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
releaseIDbodyyesId of release to delete-Array[integer]

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Release successfully deletedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Unarchive Release

PUT /rest/admin/release/unarchive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
releaseIDbodyyesId of release to unarchive-Array[integer]
projectIDbodyyesId of project to which the release belongs-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Release successfully unarchivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out

List of Cycles

POST /rest/admin/cycle/list

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
startbodyyesStart index of records-integer
limitbodyyesNumber of records per page-integer
pagebodyyesPage number to be displayed-integer
paramsbodyyesParameters-Param1

Response

Content-Type: application/json

Status CodeReasonResponse Model
200List of cycles shown successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Create Cycle

POST /rest/admin/cycle

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
cyclebodyyesprovide cycle-CycleParams

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Cycle created successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Update Cycle

PUT /rest/admin/cycle

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
cyclebodyyescheck CycleParams-UpdateCycleParams

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Cycle updated successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Archive Cycle

PUT /rest/admin/cycle/archive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
buildIDbodyyesId of cycle to archive-Array[integer]
releaseIDbodyyesId of release to which the cycle belongs-integer

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Cycle successfully archivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Delete Cycle

POST /rest/admin/cycle/delete

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
buildIDbodyyesId of cycle to delete-Array[integer]

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Cycle successfully deletedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Unarchive Cycle

PUT /rest/admin/cycle/unarchive

Description

API to unarchive cycle of release in the project

Request

Content-Type: application/json

Parameters


NameLocated inRequiredDescriptionDefaultSchema
buildIDbodyyesId of cycle to unarchive-Array[integer]
releaseIDbodyyesId of Release to which the cycle belongs-integer

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Cycle successfully unarchivedResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

List of Build

POST /rest/admin/drop/list

Description

List of all builds in the project

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
startbodyyesStart index of records-integer
limitbodyyesNumber of records per page-integer
pagebodyyesPage number to be displayed-integer
showArchivebodyyesSend 'true' to display archived Builds as well-boolean

Response

Content-Type: application/json

Status CodeReasonResponse Model
200List of buildResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Get Details of Build

POST /rest/admin/drop/read

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
jsonbodybodyyesUnique identifier of build to get its details-string
idbodyyesUnique identifier of build to get its details-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Details of build shown successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Create Build

POST /rest/admin/drops

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
dropIDbodyyesSend '0' to create drop-string
namebodyyesName of Build-string
DescriptionbodyyesDescription of Build-string
grdRelCycbodyyesAdd Release Cycle to the Build-Array[GrdRelCyc]

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Build created successfully.ResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Archive Builds

PUT /rest/admin/drop/archive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
dropIdsbodyyesId of builds to archive-Array[integer]

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Builds archived successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Unarchive Build

PUT /rest/admin/drop/unarchive

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
dropIdsbodyyesId of builds to unarchive-Array[integer]

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Builds unarchived successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

List of Platforms

POST /rest/admin/platform/list

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
startbodyyesStart index of records-integer
limitbodyyesNumber of records per page-integer
pagebodyyesPage number to be displayed-integer
sortbodynoSort parameters-Sort

Response

Content-Type: application/json

Status CodeReasonResponse Model
200List of platforms shown successfullyResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Create Platform

POST /rest/admin/platform

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
namebodyyesName of Platform-string
platformIDbodyyesSend '0' to create a new Platform-integer
platformTypebodyyesSend 'single' to add new Platform-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Platform created successfully.ResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Unlink Platforms from Test Suites

PUT /rest/testsuites/unlink/platforms

Request

Content-Type: application/json

Parameters

NameLocated inRequiredDescriptionDefaultSchema
qmTsIdbodyyesId of Test Suites-integer
platformIDbodyyesComma-separated value of platformId of Platform-string

Response

Content-Type: application/json

Status CodeReasonResponse Model
200Platforms successfully unlinked to testsuiteResponseEntity
400Invalid json object or mandatory fields missing-
401Unauthorised or session expired-
500Returned when server connection times out-

Definitions

ResponseEntity
nametyperequireddescriptionexample
headersobjectoptional-
bodyobjectoptional-
statusCodestringoptional-

Cycle
nametyperequireddescriptionexample
namestringrequiredName of Cycle
isLockedbooleanoptionalDefaulted to false
isArchivedbooleanoptionalDefaulted to false
CycleParams
nametyperequireddescriptionexample
namestringrequiredName of Cycle
startDatestringoptionalTo set StartDate of cycle
targetDatestringoptionalTo set TargetDate of cycle
projectIDstringrequiredUnique identifier of project in which the cycle is to be added
releaseIDintegerrequiredUnique identifier of release in which the cycle is to be added
UpdateCycleParams
nametyperequireddescriptionexample
namestringrequiredName of Cycle
startDatestringoptionalTo set StartDate of cycle
targetDatestringoptionalTo set TargetDate of cycle
buildIDstringrequiredUnique identifier of cycle to update
releaseIDintegerrequiredUnique identifier of release under which the cycle is created


GrdRelCyc
nametyperequireddescriptionexample
namestringoptional-
scopestringoptional-
cyclIDintegeroptional-
relIDintegeroptional-
defaultstringoptional-
ProjectParameters
nametyperequireddescriptionexample
isAutoAddValuebooleanoptionalDefaulted to true
approvalWorkflowbooleanoptionalDefaulted to true. Set true to enable eSignature in the project
namestringrequiredName of the new project
projectKeystringrequiredUnique key to identify the new project
addLdapUserbooleanoptionalSet true to allow addition of LDAP users in the project
ReleaseParams
nametyperequireddescriptionexample
namestringrequiredName of Release
descriptionstringrequiredAn explanation for the release.
Release
nametyperequireddescriptionexample
namestringrequiredName of Release
startDatestringrequiredStart date of the Release
targetDatestringrequiredTarget date of the Release
projectIDstringrequiredID of project in which the Release resides
Param1
nametyperequireddescriptionexample
releaseIDintegeroptional-
showArchivebooleanoptional-
Param2
nametyperequireddescriptionexample
showArchivebooleanrequiredSend 'true' to show archived entities
Sort
nametyperequireddescriptionexample
propertystringrequiredproperty based on which sorting is to be applied
directionstringrequiredDirection of sort - 'ASC'/'DESC'
Param4
nametyperequireddescriptionexample
projectIDstringrequiredUnique identifier of project