Page Comparison

...

Table of Contents

maxLevel	3

Get List Parameter(s) in the Project

POST /rest/parameter/list

...

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
ParameterRequest	body	yes	ParameterRequest for getting list of parameters	-

796557554

ParameterRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of Parameters shown successfully

796557554

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	-

796557554

ParameterRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	New Parameters added successfully

796557554

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}

...

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

796557554

Response
400	Mandatory fields missing	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

Archive Parameters

POST /rest/parameter/archive

...

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

796557554

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

...

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

796557554

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}

...

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	-

796557554

BaseRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of Parameter values fetch successfully

796557554

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}

...

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	-

796557554

UpdateParameter

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	Update parameter values and parameters

796557554

Response
400	Mandatory fields missing	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

Delete Parameter values

PUT /rest/parameter/deleteValue/{parameterValueID}

...

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

796557554

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

...

Content-Type: application/json

Status Code	Reason	Response Model
200	List of Projects For Specific Rights

796557554

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

...

Content-Type: application/json

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	List of Projects For Specific Rights

796557554

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

...

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

796557554

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

...

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
filters	body	yes	Filter the DataGrid List	-

796557554

BaseRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	DataGrids shown successfully

796557554

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

...

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
filters	body	yes	for filtering List of DataGrid Ids	-

796557554

BaseRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	DataGrids shown successfully

796557554

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

...

Content-Type: application/json

Parameters

Name	Located in	Required	Description	Default	Schema
DataGridModel	body	yes	DataGridModel to Create DataGrid	-

796557554

DataGridModel

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	DataGrid Created Successfully

796557554

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

...

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

796557554

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[

796557554

DatagridUpdateRequest]

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	DataGrid saved successfully

796557554

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	-

796557554

DatagridUpdateRequest

Response

Content-Type: application/json

Status Code	Reason	Response Model
200	DataGrid updated successfully

796557554

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

796557554

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

796557554

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

796557554

Response
400	Invalid json object or mandatory fields missing	-
401	Unauthorised or session expired	-
500	Returned when server connection times out	-

Definitions

Response
Anchor
Response
Response

name	type	required	description
success	boolean	optional	-
data	object	optional	-
errorMessage	string	optional	-
total	integer	optional	-

DataGridModel
Anchor
DataGridModel
DataGridModel

name	type	required	description	example
projectList	array[

796557554

API for Data Parameterization#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[

796557554

Parameter]	optional	-
hasParams	boolean	optional	-
projectIDs	array[integer]	optional	-
projects	string	optional	-
paramIDs	array[integer]	optional	-

BaseRequest
Anchor
BaseRequest
BaseRequest

name	type	required	description	example
filter	array[

796557554

Filter]	optional	-
start	integer	optional	-
limit	integer	optional	-
sort	array[Sort]	optional	-
showArchive	boolean	optional	-
showOnlyArchive	boolean	optional	-
entityIdsForBulk	boolean	optional	-

DatagridUpdateRequest
Anchor
DatagridUpdateRequest
DatagridUpdateRequest

name	type	required	description
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
Anchor
ParameterRequest
ParameterRequest

name	type	required	description
filter	array[Filter]	optional	-
start	integer	optional	-
limit	integer	optional	-
sort	array[

796557554

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
Anchor
UpdateParameter
UpdateParameter

name	type	required	description
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
Anchor
Value
Value

name	type	required	description	example
parameterValueID	integer	optional	-
value	string	optional	-

Sort
Anchor
Sort
Sort

name	type	required	description	example
property	string	optional	-
direction	string	optional	-

Filter
Anchor
Filter
Filter

name	type	required	description
value	object	optional	-
comparison	string	optional	-
type	string	optional	-
field	string	optional	-

Project
Anchor
Project
Project

name	type	required	description	example
id	integer	optional	-
name	string	optional	-

Parameter
Anchor
Parameter
Parameter

name	type	required	description
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[

796557554

ParameterValue]	optional	-
orderID	integer	optional	-
testCaseRefered	integer	optional	-

AssociatedProjects
Anchor
AssociatedProjects
AssociatedProjects

name	type	required	description	example
projectID	integer	optional	-
projectName	string	optional	-

ParameterValue
Anchor
ParameterValue
ParameterValue

name	type	required	description
parameterValueID	integer	optional	-
value	string	optional	-
orderID	integer	optional	-

Page Comparison

Versions Compared

Key

POST /rest/parameter/list

Response

POST /rest/parameter

Request

Response

PUT /rest/parameter/delete/{paramID}

Response

POST /rest/parameter/archive

Response

POST /rest/parameter/unarchive

Response

POST /rest/parameter/values/{paramID}

Response

PUT /rest/parameter/update/{paramID}

Response

PUT /rest/parameter/deleteValue/{parameterValueID}

Response

GET /rest/parameter/project/modify

GET /rest/parameter/project/view

Response

GET /rest/datagrid/getById

Response

POST /rest/datagrid/getList

Response

POST /rest/datagrid/getIDList

Response

POST /rest/datagrid/create

Response

POST /rest/datagrid/autofill

Description

Response

PUT /rest/datagrid/save

Description

Request

Response

PUT /rest/datagrid/update

Request

Response

PUT /rest/datagrid/archive

Request

Response

DELETE /rest/datagrid/delete

Request

Response

PUT /rest/datagrid/unarchive

Request

Response

Definitions

Response AnchorResponseResponse

DataGridModel AnchorDataGridModelDataGridModel

BaseRequest AnchorBaseRequestBaseRequest

DatagridUpdateRequest AnchorDatagridUpdateRequestDatagridUpdateRequest

ParameterRequest AnchorParameterRequestParameterRequest

UpdateParameter AnchorUpdateParameterUpdateParameter

Value AnchorValueValue

Sort AnchorSortSort

Filter AnchorFilterFilter

Project AnchorProjectProject

Parameter AnchorParameterParameter

AssociatedProjects AnchorAssociatedProjectsAssociatedProjects

ParameterValue AnchorParameterValueParameterValue

Response
Anchor
Response
Response

DataGridModel
Anchor
DataGridModel
DataGridModel

BaseRequest
Anchor
BaseRequest
BaseRequest

DatagridUpdateRequest
Anchor
DatagridUpdateRequest
DatagridUpdateRequest

ParameterRequest
Anchor
ParameterRequest
ParameterRequest

UpdateParameter
Anchor
UpdateParameter
UpdateParameter

Value
Anchor
Value
Value

Sort
Anchor
Sort
Sort

Filter
Anchor
Filter
Filter

Project
Anchor
Project
Project

Parameter
Anchor
Parameter
Parameter

AssociatedProjects
Anchor
AssociatedProjects
AssociatedProjects

ParameterValue
Anchor
ParameterValue
ParameterValue