Link Integrity

When you create relations between content objects in Plone (for example, via relation fields or links in text blocks), these relations are stored in the database. The Plone user interface will use those stored relations to show a warning when you try to delete a content object that is still referenced elsewhere. Link integrity avoids broken links ("breaches") in the site.

This check includes content objects that are located within a content object ("folderish content").

The @linkintegrity endpoint returns the list of reference breaches. If there are none, it will return an empty list ([]).

You can call the /@linkintegrity endpoint on the site root with a GET request and a list of UIDs in the JSON body:

http

GET /plone/@linkintegrity?uids=SomeUUID000000000000000000000001 HTTP/1.1
Accept: application/json
Authorization: Basic YWRtaW46c2VjcmV0

curl

curl -i -X GET 'http://nohost/plone/@linkintegrity?uids=SomeUUID000000000000000000000001' -H "Accept: application/json" --user admin:secret

httpie

http 'http://nohost/plone/@linkintegrity?uids=SomeUUID000000000000000000000001' Accept:application/json -a admin:secret

python-requests

requests.get('http://nohost/plone/@linkintegrity?uids=SomeUUID000000000000000000000001', headers={'Accept': 'application/json'}, auth=('admin', 'secret'))

The server will respond with the result:

TODO

The endpoint accepts a single parameter:

uids

A list of object UIDs that you want to check.