Versions Compared

Key

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

...

Name

Located in

Required

Description

Default

Schema

body

body

no


-

string

user

body

yes

Object of user to be created

-

API for Administration#UserUser

maprole

body

yes

Object of maprole having details of project roles to be assigned while creating user

-

API for Administration#MapRoleMapRole

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

User created successfully

API for Administration#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

body

body

no


-

string

user

body

yes

Object of user to be updated

-

API for Administration#UpdateUserUpdateUser

maprole

body

yes

Object of maprole having details of project roles to be assigned while updating user

-

API for Administration#MapRoleMapRole

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

User created successfully

API for Administration#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

Successful operation.

API for Administration#ResponseEntityResponseEntity

500

Returned if there is an error in server

-

...

Status Code

Reason

Response Model

200

List of users

API for Administration#ResponseEntityStringResponseEntityString

400

Invalid json object or mandatory fields missing or export operation failed.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

Status Code

Reason

Response Model

200

User deactivated successfully

API for Administration#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

User deleted successfully

API for Administration#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

List of roles shown successfully.

API for Administration#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

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

roleID

body

yes

Id of role to get execution statuses specific to that role

-

integer

isArchived

body

no

Send 'true' to show archived platforms (defaulted to false)

-

boolean

sort

body

no

Sort parameters

-

Array[API for Administration#SortSort]

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

list of execution statuses shown successfully

API for Administration#ResponseEntityStringResponseEntityString

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 fields successfully created

API for Administration#ResponseEntityStringResponseEntityString

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 system defined and user defined components

API for Administration#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

qmMasterId

body

yes

ID of custom list whose list values are to be obtained

-

integer

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 Administration#Param2Param2

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

List of all the values of the custom list

API for Administration#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

listValue

body

yes

ListValues to add

-

Array[API for Administration#ListValueListValue]

Listname

body

yes

Name of list

-

string

...

Status Code

Reason

Response Model

200

Customlist added successfully

API for Administration#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

listId

body

yes

Unique identifier of list which is to be updated

-

integer

listValueDeleted

body

yes

Provide listValues to be deleted

-

Array[API for Administration#ListValueListValue]

listValue

body

yes

ListValues

-

Array[API for Administration#ListValueListValue]

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Custom list updated

API for Administration#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

Custom-list successfully deleted

API for Administration#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

List of audit logs

API for Administration#ArrayOfDataElementsArrayOfDataElements

400

Invalid json object or mandatory fields missing or export operation failed.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Add BDD Configuration

POST /rest/admin/bddConfiguration/add

Request

Content-Type: application/json

...

Name

Located in

Required

Description

Default

Schema

repoSystem

body

yes

Type of Repository (e.g., GIT, BITBUCKET, SVN)

-

string

url

body

yes

URL of configured Repository

-

string

username

body

yes

Username to access repository

-

string

password

body

yes

Password to access repository.

Note: The password should be in base64 encoded string. You can use https://www.base64encode.org/ to encode the password in base64 format.

-

string

type

body

yes

Instance type of repository i.e. Server or Cloud

-

string

accessToken

body

no

Accesstoken for access repository.

-

string

projectID

body

yes

ID of project for which you want to configure the BDD repository

-

integer

...

List BDD Repositories

POST /rest/admin/bddConfiguration/list

Description

List of configured BDD repositories.

Request

Content-Type: application/json

...

Name

Located in

Required

Description

Default

Schema

projectID

body

yes

ID of project for which you want list of BDD repository

-

integer

start

query

no

The index of the first item to return in a page of results

-

integer

limit

query

no

The maximum number of items to return per page. The maximum is 50.

-

integer

page

query

no

The page number.

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

200

Configured Repository's list fetched successfully

API for Administration#ResponseEntityResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Test BDD Credentials

POST /rest/admin/bddConfiguration/test

Description

Test the BDD configuration

Request

Content-Type: application/json

...

Status Code

Reason

Response Model

200

Repository was verified successfully.

API for Administration#ResponseEntityResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update BDD Configuration

POST /rest/admin/bddConfiguration/update

Request

Content-Type: application/json
Parameters

...

Status Code

Reason

Response Model

200

Repository was updated successfully.

API for Administration#ResponseEntityResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete BDD Configuration

POST /rest/admin/bddConfiguration/delete

Request

Content-Type: application/json

...

Status Code

Reason

Response Model

200

Repository was deleted successfully.

API for Administration#ResponseEntityResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

...

name

type

required

description

example

userRoles

array[API for Administration#UserRolesUserRoles]

required

List of mapping for which project with what role is to be assigned


...