POST dms.response.objects.search (Webhook)

Owned by Team Oktopus
Last updated: Nov 09, 2022 by Technische Redaktion
2 min read
As of Version2021 Summer
HTTP MethodPOST
Response FormatJSON
Description

Search requests trigger this webhook if they were successful directly before the return.

The body contains the search result that will be returned.

The predicate is applied to every single object in the search result. The webhook is triggered for the whole search result as soon as one object satisfies the predicate.

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

Action Codes - History Codes-
Called by ServiceAPI-gateway service
HeaderAuthorization-Header
Example Request Body
for the search query "select system:objectTypeId, system:objectId, system:creationDate from document"
{
  "objects" : [ {
    "properties" : {
      "system:objectTypeId" : {
        "value" : "document"
      },
      "system:objectId" : {
        "value" : "2be7b709-745a-4c0c-809e-512f9850876b"
      },
      "system:creationDate" : {
        "value" : "2020-08-21T07:09:04.590Z"
      }
    }
  }, {
    "properties" : {
      "system:objectTypeId" : {
        "value" : "document"
      },
      "system:objectId" : {
        "value" : "9ce1ab26-1a6b-4bc2-aa4b-2b099bff7468"
      },
      "system:creationDate" : {
        "value" : "2020-07-23T13:12:34.370Z"
      }
    }
  }, {
    "properties" : {
      "system:objectTypeId" : {
        "value" : "document"
      },
      "system:objectId" : {
        "value" : "436f9b7d-05f3-49d5-be31-2d7225ce00f7"
      },
      "system:creationDate" : {
        "value" : "2020-07-21T11:27:31.410Z"
      }
    }
  } ],
  "numItems" : 3,
  "hasMoreItems" : true,
  "totalNumItems" : 208
}
Example PredicateCheck if at least one object of the result list contains the property appAcl:acl:

spel:properties['appAcl:acl']!=null