Back to QMetry All Products Help Page
API for Data Parameterization
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 | - | ParameterRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of Parameters shown successfully | Response |
| 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 | - | ParameterRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | New Parameters added successfully | Response |
| 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 | Response |
| 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 | Response |
| 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 | Response |
| 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 | - | BaseRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of Parameter values fetch successfully | Response |
| 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 | - | UpdateParameter |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Update parameter values and parameters | Response |
| 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 | Response |
| 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 | - | UpdateParameter |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Update parameter values and parameters | Response |
| 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 | Response |
| 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 | Response |
| 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 | Response |
| 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 | - | BaseRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrids shown successfully | Response |
| 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 | - | BaseRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrids shown successfully | Response |
| 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 | - | DataGridModel |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid Created Successfully | Response |
| 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 | Response |
| 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
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| DataGridUpdateRequest | body | yes | List of DataGridUpdateRequest to Save | - | Array[DatagridUpdateRequest] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid saved successfully | Response |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Update DataGrid
PUT /rest/datagrid/update
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| DataGridUpdateRequest | body | yes | Request to update the DataGrid | - | DatagridUpdateRequest |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid updated successfully | Response |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Archive DataGrid
PUT /rest/datagrid/archive
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dataGridIDs | body | yes | DataGrid Ids for Archive | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid archived successfully | Response |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Delete DataGrid
DELETE /rest/datagrid/delete
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dataGridID | query | yes | DataGridID for deletion | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid delete successfully | Response |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Unarchive DataGrid
PUT /rest/datagrid/unarchive
Request
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dataGridIds | body | yes | DataGrid Ids for UnArchive | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | DataGrid unarchived successfully | Response |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Definitions
Response
| name | type | required | description | example |
|---|---|---|---|---|
| success | boolean | optional | - | |
| data | object | optional | - | |
| errorMessage | string | optional | - | |
| total | integer | optional | - |
DataGridModel
| name | type | required | description | example |
|---|---|---|---|---|
| projectList | array[Project] | optional | - | |
| id | integer | optional | - | |
| archived | boolean | optional | - | |
| dataGridID | integer | optional | - | |
| name | string | optional | - | |
| description | string | optional | - | |
| createdBy | string | optional | - | |
| createdDate | string | optional | - | |
| updatedBy | string | optional | - | |
| updatedDate | string | optional | - | |
| isArchived | boolean | optional | - | |
| archivedDate | string | optional | - | |
| parameters | array[Parameter] | optional | - | |
| hasParams | boolean | optional | - | |
| projectIDs | array[integer] | optional | - | |
| projects | string | optional | - | |
| paramIDs | array[integer] | optional | - |
BaseRequest
| name | type | required | description | example |
|---|---|---|---|---|
| filter | array[Filter] | optional | - | |
| start | integer | optional | - | |
| limit | integer | optional | - | |
| sort | array[Sort] | optional | - | |
| showArchive | boolean | optional | - | |
| showOnlyArchive | boolean | optional | - | |
| entityIdsForBulk | boolean | optional | - |
DatagridUpdateRequest
| name | type | required | description | example |
|---|---|---|---|---|
| id | integer | optional | - | |
| ids | array[integer] | optional | - | |
| dataGridID | integer | optional | - | |
| ID | integer | optional | - | |
| IDs | array[integer] | optional | - | |
| parentID | integer | optional | - | |
| orderID | integer | optional | - | |
| field | string | optional | - | |
| operation | string | optional | - | |
| value | string | optional | - |
ParameterRequest
| name | type | required | description | example |
|---|---|---|---|---|
| filter | array[Filter] | optional | - | |
| start | integer | optional | - | |
| limit | integer | optional | - | |
| sort | array[Sort] | optional | - | |
| showArchive | boolean | optional | - | |
| showOnlyArchive | boolean | optional | - | |
| entityIdsForBulk | boolean | optional | - | |
| paramName | string | optional | - | |
| paramDes | string | optional | - | |
| projectID | array[integer] | optional | - | |
| values | array[string] | optional | - | |
| projectIDs | array[integer] | optional | - |
UpdateParameter
| name | type | required | description | example |
|---|---|---|---|---|
| name | string | optional | - | |
| description | string | optional | - | |
| addProject | array[integer] | optional | - | |
| removeProject | array[integer] | optional | - | |
| addValue | array[string] | optional | - | |
| editValue | array[Value] | optional | - | |
| deleteValue | array[Value] | optional | - |
Value
| name | type | required | description | example |
|---|---|---|---|---|
| parameterValueID | integer | optional | - | |
| value | string | optional | - |
Sort
| name | type | required | description | example |
|---|---|---|---|---|
| property | string | optional | - | |
| direction | string | optional | - |
Filter
| name | type | required | description | example |
|---|---|---|---|---|
| value | object | optional | - | |
| comparison | string | optional | - | |
| type | string | optional | - | |
| field | string | optional | - |
Project
| name | type | required | description | example |
|---|---|---|---|---|
| id | integer | optional | - | |
| name | string | optional | - |
Parameter
| name | type | required | description | example |
|---|---|---|---|---|
| paramID | integer | optional | - | |
| name | string | optional | - | |
| description | string | optional | - | |
| isArchived | boolean | optional | - | |
| createdDate | string | optional | - | |
| updatedDate | string | optional | - | |
| associatedProjects | array[AssociatedProjects] | optional | - | |
| projects | string | optional | - | |
| OrignalParamID | integer | optional | - | |
| parameterValues | array[ParameterValue] | optional | - | |
| orderID | integer | optional | - | |
| testCaseRefered | integer | optional | - |
AssociatedProjects
| name | type | required | description | example |
|---|---|---|---|---|
| projectID | integer | optional | - | |
| projectName | string | optional | - |
ParameterValue
| name | type | required | description | example |
|---|---|---|---|---|
| parameterValueID | integer | optional | - | |
| value | string | optional | - | |
| orderID | integer | optional | - |
Back to QMetry All Products Help Page