Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page Properties
hiddentrue
idPROGRESSDONE

Product Version2.4
Report Notepresentable
AssigneeAntje, Nils

Resources & Remarks

Nils' original description:

A multipart request body is posted. It always contains a "data" part, that contains an object list with the metadata of the affected objects. On an import or content update it can contains further parts as with renditions.

The majority of the metadata in the "data" part is still raw. That means it is not yet normalized, validated and system properties are not yet set. Only content properties are available in case of import or content update. For more details take a look at the examples below.

If the regular import route should be continued, pass the multipart to http://registry/api/dms/objects.
The metadata of the final objects are returned.

Requirements for external endpointThe target URL must be a POST endpoint accepting a multipart request body and returning a list of objects.


Modification History

NameDateProduct VersionAction
Antje08 FEB 20212.4New page properties macro.
Agnieszka26 FEB 20212020 WinterrLANG


...

As of Version2020 Winter
HTTP MethodPOST
Response FormatJSON
Predicate

The predicate is applied on all objects of the objects  list in the data part of the multipart body after enrichment. If at least one object matches, the interceptor is called.

Description

It can be triggered by

  • an object import,
  • an update of the content or
  • an update of the metadata.

The take-off point of the interceptor is after the REPOSITORY service. The initial request body is already normalized, validated and enriched with content stream properties as can be seen in the examples provided below.

The enriched multipart request body is taken by the interceptor. It always contains a data part, that contains an objects list with the metadata of the affected objects. For each object, the options section contains the action parameter that specifies the type of the call in an action code.
The predicate is applied to every single object in the list. The interceptor is triggered for the entire object list as soon as one object meets the predicate

Within the interceptor, any user-defined operation can be executed on the corresponding metadata by calling the external endpoint specified as url in the interceptor configuration. Afterwards, the modified multipart has to be routed back to continue the regular process at a suitable point.

If the interceptor should continue the regular process exactly at the take-off point, pass the multipart to http://registry/api/dms/objects.

Requirements for external endpoint The target URL must be a POST endpoint accepting a multipart request body and returning a list of objects as JSON.
Affected API Requests

POST /api/dms/objects

POST /api/dms/objects/{objectId}
PATCH /api/dms/objects/{objectId}
POST /api/dms/objects/{objectId}/contents/file

Restart Service

Repository service

HeaderAuthorization-Header

...