Versions Compared

Old Version 17

changes.mady.by.user Punit Samtani

Saved on

compared with

New Version 18

changes.mady.by.user Shravani Hendre

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel3

...

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

...

Status Code

Reason

Response Model

200

Successful operation.

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Returned if no project exists or project/release/cycle is archived

-

500

Returned if there is an error in server

-

...

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

-

API for Project, Release, Cycle, Build, Platforms#Param2Param2

Response

Content-Type: application/json

...

Status Code

Reason

Response Model

200

Release meta-data fetched successfully

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Name

Located in

Required

Description

Default

Schema

project

body

yes

Check project parameters

-

API for Project, Release, Cycle, Build, Platforms#ProjectParametersProjectParameters

release

body

yes

Check release parameters

-

API for Project, Release, Cycle, Build, Platforms#ReleaseParams

cycle

body

ReleaseParams

cycle

body

yes

Check cycle parameters

-

API for Project, Release, Cycle, Build, Platforms#Cycle

addLdapUser

body

yes

Set true to allow addition of LDAP users in the project

-

boolean

...

Status Code

Reason

Response Model

200

Project successfully addedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Project clone initiatedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Project successfully archivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Project deletion has been initialized

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorized or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Project successfully unarchivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

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

-

API for Project, Release, Cycle, Build, Platforms#Param4Param4

sort

body

yes

Sort Parameters

-

API for Project, Release, Cycle, Build, Platforms#SortSort

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

List of releases shown successfully

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Release successfully archivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Release successfully deletedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Release successfully unarchivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

...

Name

Located in

Required

Description

Default

Schema

cycle

body

yes

check CycleParams

-

API for Project, Release, Cycle, Build, Platforms#UpdateCycleParamsUpdateCycleParams

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Cycle updated successfullyAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Cycle successfully archivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Cycle successfully deleted

API for Project, Release, Cycle, Build, Platforms#ResponseEntityCycle successfully deleted

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Cycle successfully unarchivedAPI for Project, Release, Cycle, Build, Platforms#ResponseEntity

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

List of build

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Details of build shown successfully

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Builds archived successfully

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

Builds unarchived successfully

API for Project, Release, Cycle, Build, Platforms#ResponseEntityResponseEntity

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

property

string

required

property based on which sorting is to be applied


direction

string

required

Direction of sort - 'ASC'/'DESC'


Param4

name

type

required

description

example

projectID

string

required

Unique identifier of project


...