POST dms.response.objects (Webhook)
| As of Version | 2019 Winter |
|---|---|
| HTTP Method | POST |
| Response Format | JSON |
| Description | Delivers a list of predicate-matching objects to a secondary recipient. Any request returning an object list triggers this webhook directly before the return. Applies whenever object lists are part of the HTTP response: Thus, for example, properties can be extracted in order to hide them for individual users. The body contains the object list that will be returned. In most cases, this list is of length 1. Only for the search endpoint, there are also The |
| Requirements for External Endpoint | The target URL must be a POST endpoint accepting and returning a list of objects. |
| Affected API Requests and Action Codes/History Codes | |
| Restart Service | API-gateway service, Repository service |
| Header | Authorization-Header |
| Example Request Body | {
"objects" : [ {
"properties" : {
"appEmail:subject" : {
"value" : "any subject"
},
"appEmail:to" : {
"value" : [ "user1@example.de" ]
}
}
}, {
"properties" : {
"appEmail:subject" : {
"value" : "another subject"
},
"appEmail:to" : {
"value" : [ "user2@example.de" ]
}
}
} ],
"numItems" : 2,
"hasMoreItems" : true,
"totalNumItems" : 356
}
|
| Example Predicate | Check if the object type is appEmail:email.
|