GET
Filter - 02.Read
Get filter details.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request parameters
string
The filter ID
Request headers
string
Subscription key which provides access to this API.
Response 200
- string id: Filter ID. Use this value to apply the filter with the parameter filter_id on READ many method of endpoint.
- string end_point: The endpoint for the filter. For example, if you want to create a filter to select a sub-set of registries, you should use the endpoint registries. Check each endpoint documentation.
- string name: A human readable name for the filter.
- bool applied: If true the filter will be applied by default on next READ many operation for the current user. It's important to remember that filters exist at user level.
-
object
filter_definition: An object containing a single property named groups. Where groups is an array of objects with these properties:
Object properties are:-
array
expressions: An array of objects with these properties:
Object properties are:
- string property_name: Name of the property for the expression. You have to get them checking each endpoint Filter method. For example, to get all properties available to create filters for trademarks, check its Filters method.
- string comparator: A string containing the comparator to be applied with over the value. Each endpoint with method Filter provide a list of all comparators available for each property. For example, you can check trademarks Filters and its comparators available.
- string value: A string containing the value to be compared with saved property.
- string operator_next: Logic nexus with next expression. Available values are AND, OR.
-
array
expressions: An array of objects with these properties:
Loading...
{
"type": "object",
"properties": {
"enable": {
"type": "boolean"
},
"id": {
"type": "string"
},
"end_point": {
"type": "string"
},
"name": {
"type": "string"
},
"applied": {
"type": "boolean"
},
"filter_definition": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"expressions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property_name": {
"type": "string"
},
"comparator": {
"type": "string"
},
"value": {
"type": "string"
},
"personalized": {
"type": "boolean"
},
"operator_next": {
"type": "string"
}
},
"required": [
"property_name",
"comparator",
"value",
"personalized",
"operator_next"
]
}
},
"operator_next": {
"type": "string"
}
},
"required": [
"expressions",
"operator_next"
]
}
}
}
}
},
"example": {
"id": "66c4ef28-2429-46f3-b815-ab870165e520",
"end_point": "firmportfolio",
"name": "'law' in US",
"applied": false,
"filter_definition": {
"groups": [
{
"expressions": [
{
"property_name": "registry.id",
"comparator": "==",
"value": "783c0667-2884-4d0a-b93b-a6720147e45f",
"operator_next": "OR"
}
],
"operator_next": "AND"
},
{
"expressions": [
{
"property_name": "mark_text",
"comparator": "CONTAINS",
"value": "law",
"operator_next": "AND"
}
],
"operator_next": "AND"
}
]
}
}
}