| Table of Contents | ||
|---|---|---|
|
...
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
...
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
...
POST /rest/admin/customlist/list
Request
Content-Type: application/json
...
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
...
POST /rest/admin/customlist/listval
Request
Content-Type: application/json
...
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
...
POST /rest/admin/customlist/add
Request
Content-Type: application/json
...
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
...
POST /rest/admin/customlist/update
Request
Content-Type: application/json
...
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
...
POST /rest/admin/customlist/delete
Request
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
listId | body | yes | Unique identifier of Custom-list | - | integer |
Response
Content-Type: application/json
...
POST /rest/admin/accesslog/list
Request
Content-Type: application/json
...
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
...
Add BDD Configuration
POST /rest/admin/bddConfiguration/add
Request
Content-Type: application/json
...
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
...
List BDD Repositories
POST /rest/admin/bddConfiguration/list
Description
List of configured BDD repositories.
Request
Content-Type: application/json
...
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
...
Test BDD Credentials
POST /rest/admin/bddConfiguration/test
Description
Test the BDD configuration
Request
Content-Type: application/json
...
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
...
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
...
Delete BDD Configuration
POST /rest/admin/bddConfiguration/delete
Request
Content-Type: application/json
...
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
...
Get list of label values.
Request
Content-Type: application/json
...
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
...
Description
Add/update label list.
Request
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
listId | body | yes | Unique identifier of labels 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
...
API to execute batch requests
POST /rest/admin/$batch
Request
Content-Type: application/json
...
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
requests | body | yes | JsonArray of Requests | - | JsonArray |
Response
Content-Type: application/json
...