Back to QMetry All Products Help Page
API for Data Parameterization
- Mrunalini Potnis
- 1 Get List Parameter(s) in the Project
- 2 Add New Parameters
- 3 Delete Parameter
- 4 Archive Parameters
- 5 Unarchive Parameters
- 6 Get List of Parameter Values
- 7 Update Parameter/Values
- 8 Delete Parameter values [Deprecated]
- 9 Update Parameter and values
- 10 Get List of Projects having permissions to modify Test Data Parameterization
- 11 Get List of Projects having Permissions to View Test Data Parameterization
- 12 Get DataGrid
- 13 Get List of DataGrid
- 14 Get Data Grid Ids for Bulk Operations
- 15 Create DataGrid
- 16 Autofill DataGrid
- 17 Save DataGrid
- 18 Update DataGrid
- 19 Archive DataGrid
- 20 Delete DataGrid
- 21 Unarchive DataGrid
Get List Parameter(s) in the Project
POST /rest/parameter/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
ParameterRequest | body | yes | ParameterRequest for getting list of parameters | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Parameters shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Add New Parameters
POST /rest/parameter
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
ParameterRequest | body | yes | ParameterRequest for Add parameters | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | New Parameters added successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Delete Parameter
PUT /rest/parameter/delete/{paramID}
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Parameter id | body | yes | parameter Ids as query path | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Update parameter values | |
400 | Mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Archive Parameters
POST /rest/parameter/archive
Description
API to Archive list of Parameters
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Ids | body | yes | parameter Ids list | - | Array[integer] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Parameters Archived successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Unarchive Parameters
POST /rest/parameter/unarchive
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Ids | body | yes | parameter Ids list | - | Array[integer] |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Parameters Unarchive successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get List of Parameter Values
POST /rest/parameter/values/{paramID}
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Parameter id | body | yes | parameter Ids as query path | - | integer |
Base Request | body | yes | Filter,sort base request | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Parameter values fetch successfully | |
400 | Mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Parameter/Values
PUT /rest/parameter/update/{paramID}
Description
API to update parameter and its values
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Parameter id | body | yes | parameter Ids as query path | - | integer |
UpdateParameter | body | yes | UpdateParameter for update parameter | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Update parameter values and parameters | |
400 | Mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Delete Parameter values [Deprecated]
PUT /rest/parameter/deleteValue/{parameterValueID}
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
parameterValueID | body | yes | parameterValueID as query path | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Update parameter values | |
400 | Mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Update Parameter and values
PUT /rest/parameter/update/{paramID}
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Parameter id | body | yes | parameter Ids as query path | - | integer |
UpdateParameter | body | yes | UpdateParameter for update parameter | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Update parameter values and parameters | |
400 | Mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get List of Projects having permissions to modify Test Data Parameterization
GET /rest/parameter/project/modify
Request
Content-Type: application/json
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Projects For Specific Rights | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get List of Projects having Permissions to View Test Data Parameterization
GET /rest/parameter/project/view
Request
Content-Type: application/json
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | List of Projects For Specific Rights | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get DataGrid
GET /rest/datagrid/getById
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
dataGridID | query | yes | DataGridID to get DataGrid | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | DataGrid 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 DataGrid
POST /rest/datagrid/getList
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
filters | body | yes | Filter the DataGrid List | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | DataGrids shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Get Data Grid Ids for Bulk Operations
POST /rest/datagrid/getIDList
Description
API to get DataGrid IDs List
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
filters | body | yes | for filtering List of DataGrid Ids | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | DataGrids shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Create DataGrid
POST /rest/datagrid/create
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
DataGridModel | body | yes | DataGridModel to Create DataGrid | - |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | DataGrid Created Successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Autofill DataGrid
POST /rest/datagrid/autofill
Description
API to Autofill DataGrid
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
Parameter Ids | body | yes | Parameter Ids to Autofill | - | Array[integer] |
rows | query | no | Number of Rows to Autofill | - | integer |
isRandom | query | no | Flag to fill Randomly | - | boolean |
isSequential | query | no | Flag to fill sequentially | - | boolean |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | DataGrid Autofilled successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Save DataGrid
PUT /rest/datagrid/save
Description
API to Save DataGrid
Request
Parameters