POST dms.request.search (Webhook)

Owned by Technische Redaktion
Last updated: Nov 09, 2022
1 min read
As of Version2019 Winter
HTTP MethodPOST
Response FormatJSON
Description

The search endpoint and any endpoint containing a search request can trigger this webhook. Check the value of the incoming search query parameter.

The webhook accepts a body containing an object that is modified (if necessary) and returned.

The predicate is applied to the search query parameter.

Requirements for External EndpointThe target URL must be a POST endpoint accepting and returning a list of objects.
Affected API Requests

POST /api/dms/objects/search

POST /api/dms/objects/tags/{name}/state/{state}?query=<SQL>

Called by ServiceAPI-gateway service
HeaderAuthorization-Header
Example Request Body
{
    "query": {
        "statement": "select * from appEmail:email where appEmail:bcc is not null",
        "skipCount": 0,
        "maxItems": 10
    },
    "options": {
        "tenant": "default"
    }
}
Example PredicateCheck whether the query statement contains the string 'bcc':

spel:query!=null && query['statement']!=null && query['statement'].toLowerCase().contains('bcc'))