| Table of Contents | ||
|---|---|---|
|
...
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
...
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 | - | API for Project, Release, Cycle, Build, Platforms#Param2Param2 |
Response
Content-Type: application/json
...
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#ReleaseParamsReleaseParams |
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#ResponseEntityString | |
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 | - |
Response
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
releaseParams | body | yes | Release Parameters | - | API for Project, Release, Cycle, Build, Platforms#Release |
cycle | body | yes | Cycle Parameters | - | API for Project, Release, Cycle, Build, Platforms#Cycle |
Response
Content-Type: application/json
...
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#Param1Param1 |
Response
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema | ||
|---|---|---|---|---|---|---|---|
cycle | body | yes | provide cycle | - | API for Project, Release, Cycle, Build, Platforms#CycleParams | - |
Response
Content-Type: application/json
...
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 | List of build | API for Project, Release, Cycle, Build, Platforms#ResponseEntityStringResponseEntityString |
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 |
|---|---|---|---|---|---|
dropID | body | yes | Send '0' to create drop | - | string |
name | body | yes | Name of Build | - | string |
Description | body | yes | Description of Build | - | string |
grdRelCyc | body | yes | Add Release Cycle to the Build | - | Array[API for Project, Release, Cycle, Build, Platforms#GrdRelCycGrdRelCyc] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Build created successfully. | API for Project, Release, Cycle, Build, Platforms#ResponseEntityStringResponseEntityString |
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 |
sort | body | no | Sort parameters | - |
Response
Content-Type: application/json
...
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 |
...