Incoming References

Get Incoming Publication References for a Document

Required scope: public-api:read

Description

This endpoint returns all publications which link to this document (via content or metadata)

The example below finds a reference to ID 1 when requesting for incomingDocumentReference with ID 2.

Use Cases

Find publications that link to this document for cache invalidation

Notes

Eventual Consistency of Reference because of the usage of Elasticsearch

Not Supported

Find publications in a Document List put on another document.

Curl Example

ACCESS_TOKEN=ey1234
curl -k -X GET "https://server.livingdocs.io/api/v1/documents/:documentId/incomingDocumentReferences" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Endpoint

GET api/v1/documents/:documentId/incomingDocumentReferences

Parameters

Name	Type	Required	Notes
:documentId	integer	x
?limit	integer		A limit for how much published documents to retrieve. Defaults to 100. Max. 100.
?offset	integer		An offset into the query. Useful when getting more than 100 results (pagination).

Response

200

[
  {
    "id": 4,
    "references": [
      {
        "id": "1",
        "type": "document",
        "location": "include-directive",
        "componentId": "doc-1euiflvoq0",
        "serviceName": "editable-teaser",
        "propertyName": "article",
        "componentName": "teaser-include",
        "directiveName": "teaser"
      }
    ]
  },
  {
    "id": 2,
    "references": [
      {
        "id": "1",
        "type": "document",
        "location": "include-directive",
        "componentId": "doc-1eu6i7l880",
        "serviceName": "editable-teaser",
        "propertyName": "article",
        "componentName": "teaser-include",
        "directiveName": "teaser"
      }
    ]
  }
]

Get Incoming Media References for a Document