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
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
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
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
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
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
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
start	body	no	provide start	-	integer
limit	body	no	provide limit	-	integer
page	body	no	provide page	-	integer

Response

Content-Type: application/json

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
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
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
userID	body	yes	Unique identifier of user to delete	-	integer

Response

Content-Type: application/json

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
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
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
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
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 List of fields

POST /rest/admin/managefield/list

Request

Content-Type: application/json

Parameters

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
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
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
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
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
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
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
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
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
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
listId	body	yes	Unique identifier of Custom-list	-	integer

Response

Content-Type: application/json

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

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
start	body	yes	start index of records	-	integer
limit	body	yes	number of records per page (max. value 50)	-	integer
page	body	yes	page number	-	integer
fromDate	body	yes	start date to filter the records (date format as per set in User Profile)	-	string
toDate	body	yes	end date of records (date format as per set in User Profile)	-	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of audit logs	ArrayOfDataElements
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

Parameters

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
projectID	body	yes	ID of project for which you want to configure the BDD repository	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of folders fetched successfully	ResponseEntity
400	Missing mandatory fields.	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

List BDD Repositories

POST /rest/admin/bddConfiguration/list

Description

List of configured BDD repositories.

Request

Content-Type: application/json

Parameters

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	ResponseEntity
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

Parameters

Name	Located in	Required	Description	Default	Schema
repoSystem	body	yes	Type of Repository (e.g., GIT, BITBUCKET, SVN).	-	string
url	body	yes	URL of the 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

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Repository was verified successfully.	ResponseEntity
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

Name	Located in	Required	Description	Default	Schema
repoSystem	body	yes	Type of Repository (e.g., GIT, BITBUCKET, SVN).		string
url	body	yes	URL of the configured Repository		string
username	body	yes	Username to access the repository.		string
password	body	yes	Password to access the 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
bddConfigID	body	yes	ID of BDD repository for particular project from DB.		integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Repository was updated successfully.	ResponseEntity
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

Parameter

Name	Located in	Required	Description	Default	Schema
bddConfigID	body	yes	ID of BDD repository for particular project from DB.	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Repository was deleted successfully.	ResponseEntity
400	Missing mandatory fields.	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

Definitions

ResponseEntity

name	type	required	description
headers	object	optional	-
body	object	optional	-
statusCode	string	optional	-

ExtraParams

name	type	required	description	example
showInActive	boolean	optional	Send true to see deactivated users as well(defaulted to false)

ListValue

name	type	required	description
name	string	required	Name of list value
alias	string	required	Alias of list value
createdDate	string	required	Created date of the list value
Value	string	required	weightage of the list value
Id	integer	required	ID of list value to update/delete, '0' when list value is to be added

Param2

name	type	required	description	example
showArchive	boolean	required	Send 'true' to show archived entities

Sort

name	type	required	description	example
property	string	optional	-
direction	string	optional	-

ArrayOfDataElements

name	type
accessLogID	long
actionName	string
accessDate	string
accessUser	string
projectName	string
moduleName	string
entityKey	string
id	string
projectID	integer
version	string
message	string
screenName	string
userActionName	string

User

name	type	required	description
isActive	boolean	optional	True is user is active, else false
userType	integer	required	Type of user
isLabel	boolean	optional	True if its a label
loginId	string	required	Login id of user
userAlias	string	required	Alias of user
firstName	string	required	Firstname of user
lastName	string	required	Lastname of user
email	string	required	Email of user
dateTimeFormatID	integer	optional	Type of Date Time format
timeZoneID	integer	optional	Time zone of user
localeID	integer	optional	Locale of user
authType	string	optional	Type of authentication to be used to login by user

UpdateUser

name	type	required	description
userID	integer	required	Id of user
userType	integer	required	Type of user
loginId	string	required	Login id of user
userAlias	string	required	Alias of user
firstName	string	required	Firstname of user
lastName	string	required	Lastname of user
email	string	required	Email of user

MapRole

name	type	required	description	example
userRoles	array[UserRoles]	required	List of mapping for which project with what role is to be assigned

UserRoles

name	type	required	description	example
projectID	integer	required	ID of the project
roleID	integer	required	ID of the role

ResponseEntityString

name	type	required	description
headers	object	optional	-
body	string	optional	-
statusCode	string	optional	-
statusCodeValue	integer	optional	-