Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

System Hooks, that allow for messaging triggered by function calls under specified conditions.

Table of Contents

As of Version2.3
HTTP MethodGET
Response FormatJSON
DescriptionObject deletion events can trigger this AMQP Hook with the corresponding object properties in its body.
Example Predicate

1) reaction to every object deletion:
spel:true

2) reaction to every object deletion of type document:
spel:properties['system:objectTypeId']['value']=='document'

3) reaction to every failed deletion of objects that were flagged for deletion:
spel:options['action']==202

Action Codes - History Codes200 - OBJECT_DELETED
202 - OBJECT_FLAGGED_FOR_DELETE
Example Response
{
    "objects": [      
        {
            "properties": {
                "system:objectId": {
                    "value": "333c226c-3a44-5e66-7777-8d999a0000e1"
                },
                "system:baseTypeId": {
                    "value": "system:document"
                },
                "system:objectTypeId": {
                    "value": "document"
                },
                "system:createdBy": {
                    "value": "111c226c-3a44-5e66-7777-8d999a0000e1"
                },
                "system:creationDate": {
                    "value": "2020-09-16T16:57:40.780Z"
                },
                "system:lastModifiedBy": {
                    "value": "275c826c-6a61-4e89-9512-8d935a1631e5"
                },
                "system:lastModificationDate": {
                    "value": "2020-09-16T16:57:40.780Z"
                },
                "system:versionNumber": {
                    "value": 1
                },
                "system:tenant": {
                    "value": "default"
                },
                "system:traceId": {
                    "value": "e686f806ed44f37d"
                },
                "Name": {
                    "value": "test.eml"
                }
            },
            "contentStreams": [
                {
                    "contentStreamId": "0AB98765-CDEF-4321-ABCD-098EF76AB543",
                    "archivePath": "default/DOCUMENT/32/15/7/",
                    "length": 82683,
                    "mimeType": "message/rfc822",
                    "fileName": "test.eml",
                    "digest": "2713BB70F1B3F8F556D2661286A5D45157EB723A815E1066E50F1808228075F7",
                    "range": "47578-68248,115827-136497,184076-204746,252320-272989",
                    "repositoryId": "repo252"
                }
            ],

           "options": {
             "action": 200,
             "detail": "OBJECT_DELETED"

           }       

        }
    ]
}

Summary

In this article, we gave an introduction to AMQP Hooks, covered the configuration using the example of asynchronous full text indexing and provide a list of all AMQP Hooks available. Check out Webhooks which are the second type of System Hooks in yuuvis® Momentum.


Read on

System Hooks

Define additional actions triggered by specified events, extend the functionality of yuuvis® Momentum API. Keep reading

Webhooks

A system hook that extends a function call by an HTTP call under defined conditions. Keep reading

  • No labels