Back to QMetry All Products Help Page
API for Administration
- Mrunalini Potnis
- 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 List of fields
- 10 Get List of Custom Lists and Dropdowns
- 11 Get List of Custom List Values
- 12 Add Custom List
- 13 Add/Update Custom List
- 14 Delete Custom List
- 15 Get List of Audit Logs
- 16 Add BDD Configuration
- 17 List BDD Repositories
- 18 Test BDD Credentials
- 19 Update BDD Configuration
- 20 Delete BDD Configuration
- 21 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 | 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 | |
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 | |
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 | |
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 |
|---|