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

Name

Located in

Required

Description

Default

Schema

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

Status Code

Reason

Response Model

200

Successful operation.

ResponseEntity

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

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

-

Param2

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of projects shown successfully

ResponseEntity

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

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

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release meta-data fetched successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Create Project

POST /rest/admin/project

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

project

body

yes

Check project parameters

-

ProjectParameters

release

body

yes

Check release parameters

-

ReleaseParams

cycle

body

yes

Check cycle parameters

-

Cycle

addLdapUser

body

yes

Set true to allow addition of LDAP users in the project

-

boolean

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Project successfully added

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Clone Project

POST /rest/admin/project/clone

Description

API to clone project

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

apiKey

-

string

scope

header

yes

scope

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Project clone initiated

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Project

PUT /rest/admin/project/archive

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectID

body

yes

Unique identifier of projects to archive

-

Array[integer]

apiKey

header

yes

apiKey

-

string

scope

header

yes

scope

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Project successfully archived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Project

PUT /rest/admin/project/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectID

body

yes

Unique identifier of project to delete

-

integer

apiKey

header

yes

apiKey

-

string

scope

header

yes

scope

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Project deletion has been initialised

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorized or session expired

-

500

Returned when server connection times out

-

Unarchive Project

PUT /rest/admin/project/unarchive

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

projectID

body

yes

Unique identifier of projects to unarchive

-

Array[integer]

apiKey

header

yes

apiKey

-

string

scope

header

yes

scope

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Project successfully unarchived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

List of Releases

POST /rest/admin/release/list

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

-

Param4

sort

body

yes

Sort Parameters

-

Sort

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of releases shown successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Create Release

POST /rest/admin/release

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

releaseParams

body

yes

Release Parameters

-

Release

cycle

body

yes

Cycle Parameters

-

Cycle

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Release

PUT /rest/admin/release/archive

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release successfully archived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Release

POST /rest/admin/release/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

releaseID

body

yes

Id of release to delete

-

Array[integer]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release successfully deleted

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Unarchive Release

PUT /rest/admin/release/unarchive

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Release successfully unarchived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

 

List of Cycles

POST /rest/admin/cycle/list

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

-

Param1

Response

Content-Type: application/json

Status Code

Reason

Response Model

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

-

Create Cycle

POST /rest/admin/cycle

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

cycle

body

yes

provide cycle

-

CycleParams

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Cycle created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Cycle

PUT /rest/admin/cycle

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

cycle

body

yes

check CycleParams

-

UpdateCycleParams

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Cycle updated successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Archive Cycle

PUT /rest/admin/cycle/archive

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Cycle successfully archived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Cycle

POST /rest/admin/cycle/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

buildID

body

yes

Id of cycle to delete

-

Array[integer]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Cycle successfully deleted

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned 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

Name

Located in

Required

Description

Default

Schema

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Cycle successfully unarchived

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned 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

Name

Located in

Required

Description

Default

Schema

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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of build

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get Details of Build

POST /rest/admin/drop/read

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

jsonbody