API for Administration

Create User and Map Roles

POST /rest/admin/user/withrole

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

body

body

no



-

string

user

body

yes

Object of user to be created

-

User

maprole

body

yes

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

-

MapRole

 

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

User created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Update Role/Project for User

PUT /rest/admin/user/update/withrole

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

body

body

no



-

string

user

body

yes

Object of user to be updated

-

UpdateUser

maprole

body

yes

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

-

MapRole


Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

User created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Generate/Reset Automation API Key

POST /rest/admin/user/generateAutomationAPIKey

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

Content-Type

header

yes

application/json

-

string

apikey

header

yes

Open API key

-

string

scope

header

yes

default

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Successful operation.

ResponseEntity

500

Returned if there is an error in server

-

Get List of Users

POST /rest/admin/user/list

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

start

body

yes

provide start

-

integer

limit

body

yes

provide limit

-

integer

page

body

yes

provide page

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of users

ResponseEntityString

400

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

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Deactivate User

PUT /rest/admin/user/deactivate

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

userID

body

yes

Unique identifier of user to be deactivated

-

integer

isActive

body

yes

Send 'false' to deactivate user

-

boolean

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

User deactivated successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete User

PUT /rest/admin/user/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

userID

body

yes

Unique identifier of user to delete

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

User deleted 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 Roles

POST /rest/admin/role/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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of roles 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 Execution Statuses

POST /rest/admin/execution/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

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[Sort]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

list of execution statuses shown successfully

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get Automation Progress Status

GET /rest/admin/status/automation/{requestId}

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

requestId 

body

yes

Automation request ID to get the details of the test suite key and import status.

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

403

Forbidden

-

404

Not Found

-

500

Returned when server connection times out

-

Get List of fields

POST /rest/admin/managefield/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

projectID

body

yes

Unique identifier of project whose field list has to be obtained

-

integer

isSystemFieldRequired

body

no

Send True to get System fields and false to get User fields. Defaulted to false

-

boolean

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of fields successfully created

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get List of Custom Lists and Dropdowns

POST /rest/admin/customlist/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

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of system defined and user defined components

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get List of Custom List Values

POST /rest/admin/customlist/listval

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

-

Param2

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

List of all the values of the custom list

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Add Custom List

POST /rest/admin/customlist/add

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

listValue

body

yes

ListValues to add

-

Array[ListValue]

Listname

body

yes

Name of list

-

string

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Customlist added successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Add/Update Custom List

POST /rest/admin/customlist/update

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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[ListValue]

listValue

body

yes

ListValues

-

Array[ListValue]

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Custom list updated

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Delete Custom List

POST /rest/admin/customlist/delete

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

Name

Located in

Required

Description

Default

Schema

listId

body

yes

Unique identifier of Custom-list

-

integer

Response

Content-Type: application/json

Status Code

Reason

Response Model

Status Code

Reason

Response Model

200

Custom-list successfully deleted

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

Get List of Audit Logs

POST /rest/admin/accesslog/list

Request