Back to QMetry All Products Help Page
API for Administration
- 1 Create User and Map Roles
- 2 Update Role/Project for User
- 3 Generate/Reset Automation API Key
- 4 Get List of Users
- 5 Deactivate User
- 6 Delete User
- 7 Get List of Roles
- 8 Get List of Execution Statuses
- 9 Get Automation Progress Status
- 10 Get List of fields
- 11 Get List of Custom Lists and Dropdowns
- 12 Get List of Custom List Values
- 13 Add Custom List
- 14 Add/Update Custom List
- 15 Delete Custom List
- 16 Get List of Audit Logs
- 17 Add BDD Configuration
- 18 List BDD Repositories
- 19 Test BDD Credentials
- 20 Update BDD Configuration
- 21 Delete BDD Configuration
- 22 Get List of Label Values
- 23 Add/Update Label List
- 24 API to execute batch requests
- 25 Get Info of root folder
- 26 Definitions
Create User and Map Roles
POST /rest/admin/user/withrole
Request
Content-Type: application/json
Parameters
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | User created successfully | |
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 | - | |
maprole | body | yes | Object of maprole having details of project roles to be assigned while updating user | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | User created successfully | |
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. | |
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 | 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 | |
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 | |
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 | |
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. | |
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 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 | successfully | |
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 |
|---|---|---|---|---|---|
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 | |
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 | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of all the values of the custom list | |
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 | |
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
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Custom list updated | |
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 | |
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 | |
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 |
accessToken | body | no | Accesstoken for access repository. | - | 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 | Repository was added successfully. | ResponseEntityString |
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 | |
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. | |
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. | |
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. | |
400 | Missing mandatory fields. | - |
401 | Unauthorised or session expired. | - |
500 | Returned when server connection times out. | - |
Get List of Label Values
POST /rest/admin/labels/listval
Description
Get list of label values.
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
qmMasterId | body | yes | ID of 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 | - | |
projectID | body | no | ID of project for which 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 LabelsLi | |
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 | - |
Add/Update Label List
POST /rest/admin/labels/update
Description
Add/update label list.
Request
Content-Type: application/json
Parameters
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Label list updated | |
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 server connection times out | - |
Get Info of root folder
POST /rest/admin/project/getRootFolderInfo
Description
Provides basic information about the project's root folder like id, folder name, count, etc.
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 server | - |
Definitions
ResponseEntity
name | type | required | description | example |
|---|---|---|---|---|
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 | example |
|---|---|---|---|---|
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 | example |
|---|---|---|---|---|
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 | |
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 | example |
|---|---|---|---|---|
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 | |
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 | example |
|---|---|---|---|---|
headers | object | optional | - | |
body | string | optional | - | |
statusCode | string | optional | - | |
statusCodeValue | integer | optional | - |
Back to QMetry All Products Help Page