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.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the server connection times out.	-

Create User Defined Field

POST /rest/admin/userdefinefield/create

Description

Creates a User Defined Field (UDF) and assigns it to one or more project modules.

Request

Content-Type: application/json

Parameters

Table 64. Create User Defined Field

Name	Located in	Required	Description	Schema
fieldTypeID	body	yes	Type of the UDF. See the field type table below.	integer
name	body	yes	Internal name of the UDF.	string
label	body	yes	Display label of the UDF.	string
fieldLength	body	no	Maximum length, applicable to String type UDFs.	integer
lookuplistId	body	conditional	Id of the lookup list. Required for Lookup, Multi Lookup List, and Cascading List types.	integer
data	body	yes	Array describing the project(s) and module(s) the field is assigned to.	Array[Data]

Data

Table 65. Data

Name	Required	Description	Schema
projectID	yes	Id of the project the field is assigned to.	integer
projectName	yes	Name of the project.	string
modules	yes	Array of modules to assign the field to. Each has moduleID and mandatory.	Array[Module]
moduleModel	no	Module model array (pass empty when not used).	Array
defaultValue	no	Default value for the field (used by lookup-type fields; may be null).	object

Example 56. UDF Types and Sample Requests

String UDF Request

{"fieldTypeID":6,"name":"udf_str","label":"udf_str","fieldLength":12,"data":[{"projectID":1856,"projectName":"01P5W","modules":[{"moduleID":1,"mandatory":false}],"moduleModel":[]}]}

Large Text UDF Request

{"fieldTypeID":2,"name":"largetext_udf","label":"largetext_udf","data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[]}]}

Lookup UDF Request

{"fieldTypeID":3,"name":"lookuplist_123","label":"lookuplist_123","lookuplistId":9732,"data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[],"defaultValue":null}]}

Multi Lookup List UDF Request

{"fieldTypeID":4,"name":"multilookup_udf","label":"multilooup_udf","lookuplistId":9733,"data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[],"defaultValue":null}]}

Number UDF Request

{"fieldTypeID":5,"name":"number_udf","label":"number_udf","data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[]}]}

Datetime Picker UDF Request

{"fieldTypeID":1,"name":"datetimepicker","label":"datetimepicker","data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[]}]}

Cascading List UDF Request

{"fieldTypeID":7,"name":"cascadinglist","label":"cascadinglist","lookuplistId":9103,"data":[{"projectID":1,"projectName":"QMetry","modules":[{"moduleID":32,"mandatory":false}],"moduleModel":[],"defaultValue":null}]}

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	UDF created successfully.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the server connection times out.	-

List User Defined Field Types

POST /rest/admin/userdefinefieldtype/list

Description

Returns the list of available User Defined Field types that can be used when creating a UDF. Each type's Id corresponds to the fieldTypeID accepted by the create endpoint.

Request

Content-Type: application/json

Takes an empty JSON body:

{}

Response

Content-Type: application/json

Returns an array of field type objects.

Status Code	Reason	Response Model
200	Field types fetched successfully.	Array[FieldType]
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the server connection times out.	-

Example 57. Example response body

[
  { "Id": 6, "Fieldtype": "STRING", "Description": "Any text string can be entered in this field in plain text.", "Preview": "ad-string-ico" },
  { "Id": 2, "Fieldtype": "LARGETEXT", "Description": "A large plain text field.", "Preview": "ad-large-text-ico" },
  { "Id": 3, "Fieldtype": "LOOKUPLIST", "Description": "An input which can be associated to any custom list define within the current project. Only one item can be selected at a time from this list.", "Preview": "ad-lookup-list-ico" },
  { "Id": 4, "Fieldtype": "MULTILOOKUPLIST", "Description": "An input which can be associated to any custom list define within the current project. Multiple is can be selected at a time.", "Preview": "ad-multi-select-lookup-list-ico" },
  { "Id": 5, "Fieldtype": "NUMBER", "Description": "Any number can be enter into this field.", "Preview": "ad-number-ico" },
  { "Id": 1, "Fieldtype": "DATETIMEPICKER", "Description": "This will open a calendar control which will allow the user to select a date.", "Preview": "ad-date-picker-ico" },
  { "Id": 7, "Fieldtype": "CASCADINGLIST", "Description": "A single-level cascading select list where child values depend on the parent selection.", "Preview": "ad-cascading-list-ico" }
]

Update Role or 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 the user to be updated.	-	UpdateUser
maprole	body	yes	Object of maprole having details of project roles to be assigned while updating the user.	-	MapRole

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	User created successfully.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the server connection times out.	-

Generate or 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.	Response Entity
500	Returned if there is an error on the 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	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
200	List of users	Response Entity String
400	Invalid JSON object or mandatory fields missing, or export operation failed.	-
401	Unauthorised or session expired.	-
500	Returned whenthe 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 the user to be deactivated.	-	integer
isActive	body	yes	Send 'false' to deactivate the user.	-	boolean

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	User deactivated successfully.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the user to delete.	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	User deleted successfully.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned whenthe 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.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the 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	The list of execution statuses shown successfully.	ResponseEntityString
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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
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
200	Successful.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
403	Forbidden.	-
404	Not found.	-
500	Returned when the 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 the 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 the 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.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the 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.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the list.	-	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Custom list added successfully.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the list that 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.	Response Entity
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the Custom-list.	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Custom-list successfully deleted.	Response Entity
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 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 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 for example, Server or Cloud.	-	string
accessToken	body	no	Access token for the access repository.	-	string
projectID	body	yes	ID of the project for which you want to configure the BDD repository.	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Repository was added successfully.	ResponseEntityString
400	Missing mandatory fields.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the project for which you want a list of BDD repositories.	-	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.	Response Entity
400	Missing mandatory fields.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 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, for example, Server or Cloud.	-	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	The repository was verified successfully.	Response Entity
400	Missing mandatory fields.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 (such as, 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, for example, Server or Cloud.	-	string
bddConfigID	body	yes	ID of the BDD repository for a particular project from the DB.		integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	The repository was updated successfully.	Response Entity
400	Missing mandatory fields.	-
401	Unauthorised or session expired.	-
500	Returned when the 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 the BDD repository for a particular project from the DB.	-	integer

Response

Content-Type: application/json

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

Get List of Label Values

POST /rest/admin/labels/listval

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
qmMasterId	body	yes	ID of the labels list whose list values are to be obtained.	-	integer
qmMode	body	no	Mode of operation like EDIT, ADD.	-	string
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	no	Parameters	-	Param2
projectID	body	no	ID ofthe project for which the possible labels list values to be obtained.	-	integer

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of all the values of the Labels Li.	Response Entity
201	Created.	-
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
403	Forbidden.	-
404	Not found.	-
500	Returned when the server connection times out.	-

Add/Update Label List

POST /rest/admin/labels/update

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
listId	body	yes	Unique identifier of the labels list that 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	Label list updated.	Response Entity
201	Created.	-
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.	-

API to execute batch requests

POST /rest/admin/$batch

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
requests	body	yes	JsonArray of Requests.	-	JsonArray

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Batch requests executed successfully.	ResponseEntityString
400	Invalid JSON object or mandatory fields missing.	-
401	Unauthorised or session expired.	-
429	Returned when more than 10 requests are passed for batch execution.	-
500	Returned when the server connection times out.	-

Get Info of root folder

POST /rest/admin/project/getRootFolderInfo

Request

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
data	body	yes	data	-	string

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Successful operation.	ResponseEntityString
400	Returned if there is an error.	-
401	Unauthorised or session expired.	-
500	Returned if there is an error in the server.	-

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 if the 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 the user.
userAlias	string	required	Alias of the user.
firstName	string	required	First name of the user.
lastName	string	required	Last name of the user.
email	string	required	Email of the user.
dateTimeFormatID	integer	optional	Type of Date Time format.
timeZoneID	integer	optional	Time zone of the user.
localeID	integer	optional	Locale of the user.
authType	string	optional	Type of authentication to be used to log in by the user.

UpdateUser

name	type	required	description
userID	integer	required	Id of user
userType	integer	required	Type of user
loginId	string	required	Login id of the user.
userAlias	string	required	Alias of the user.
firstName	string	required	First name of the user.
lastName	string	required	Last name of the user.
email	string	required	Email of the 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	-

In this section: