Jump to

• Request
• Response

Retrieves Filter Criteria Query

get

/service/v1/filterQuery

This endpoint is used to get filter criteria query

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• appCode: string
  Application Code
• category: string
  Category for which filter query need to be fetched
• eventCode(optional): string
  Event code for which filter query need to be fetched

Header Parameters

• appId: string
  Application Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

List of filter queries for given category & event code

Body ()

Root Schema : ScfTransOutputResponse

Type: object

Output response from transaction API

Show Source

• queryList(optional): array queryList

{
    "description":"Output response from transaction API",
    "type":"object",
    "properties":{
        "queryList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfFilterQueryModel"
            }
        }
    }
}

Nested Schema : queryList

Type: array

Show Source

• Array of: object ScfFilterQueryModel
  Query and attribute list model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfFilterQueryModel"
    }
}

Nested Schema : ScfFilterQueryModel

Type: object

Query and attribute list model

Show Source

• query(optional): string
  Filter Query
• queryId(optional): number
  Query Id
• ScfTransCriteriaQueryAttributeModel(optional): array ScfTransCriteriaQueryAttributeModel

{
    "description":"Query and attribute list model",
    "type":"object",
    "properties":{
        "queryId":{
            "description":"Query Id",
            "type":"number"
        },
        "query":{
            "description":"Filter Query",
            "type":"string"
        },
        "ScfTransCriteriaQueryAttributeModel":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTransCriteriaQueryAttributeModel"
            }
        }
    }
}

Nested Schema : ScfTransCriteriaQueryAttributeModel

Type: array

Show Source

• Array of: object ScfTransCriteriaQueryAttributeModel
  Query for each type of given category

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTransCriteriaQueryAttributeModel"
    }
}

Nested Schema : ScfTransCriteriaQueryAttributeModel

Type: object

Query for each type of given category

Show Source

• columnName(optional): string
  Corresponding column of the input parameter index in the query
• mappedParam(optional): string
  Mapped column of the input parameter index in the query
• paramIndex(optional): integer
  Input parameter index in the query
• paramName(optional): string
  Input parameter name in the query

{
    "description":"Query for each type of given category",
    "type":"object",
    "properties":{
        "paramIndex":{
            "description":"Input parameter index in the query",
            "type":"integer"
        },
        "paramName":{
            "description":"Input parameter name in the query",
            "type":"string"
        },
        "columnName":{
            "description":"Corresponding column of the input parameter index in the query",
            "type":"string"
        },
        "mappedParam":{
            "description":"Mapped column of the input parameter index in the query",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top