API for Data Parameterization

API for Data Parameterization

POST /rest/parameter/list

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-

POST /rest/parameter

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-

PUT /rest/parameter/delete/{paramID}

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-

POST /rest/parameter/archive

Description

API to Archive list of Parameters

Request

Content-Type: application/json

Parameters

Name

Located in

Required

Description

Default

Schema

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

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

-