Retrieves Filter Parameters
get
/web/v1/filterParams
This endpoint is used to get the Filter Parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
applicationCode: string
Application Code
-
category: string
Category for which parameters need to be fetched
-
eventCode(optional): string
Event code mapped to the category that needs to be fetched
-
language(optional): string
Language in which parameter labels need to be fetched
Header Parameters
-
appId: string
Application Id
-
branchCode: string
Branch Code
-
userId: string
User Id
Response
Supported Media Types
- application/json
- application/xml
200 Response
Filter parameter details
Root Schema : ScfFilterCriteriaModelKeyCollection
Type:
object
Collection of list of Parameters.
Show Source
Nested Schema : ScfFilterParamModelCollection
Type:
Show Source
array
-
Array of:
object ScfFilterParamModelCollection
Collection of Scf filter parameters
Nested Schema : ScfFilterParamModelCollection
Type:
object
Collection of Scf filter parameters
Show Source
-
description(optional):
string
Filter Description
-
hierarchy(optional):
string
hierarchy of the criteria
-
ScfFilterParamModel(optional):
array ScfFilterParamModel
-
type(optional):
string
Filter criteria
Nested Schema : ScfFilterParamModel
Type:
Show Source
array
-
Array of:
object ScfFilterParamModel
Scf Filter Parameters model
Nested Schema : ScfFilterParamModel
Type:
object
Scf Filter Parameters model
Show Source
-
columnName(optional):
string
Name of the mapped column for given parameter
-
endpointValue(optional):
string
Endpoint Value
-
fieldType(optional):
string
Field Type
-
label(optional):
string
Label of the parameter for given language
-
lovConfig(optional):
array lovConfig
LOV Config Data
-
parameter(optional):
string
Name of the parameter
-
reqParams(optional):
string
Request Parameters
Nested Schema : lovConfig
Type:
array
LOV Config Data
Show Source
-
Array of:
object Map
Additional Properties Allowed: additionalProperties
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error