Get Linked Data

This service task retrieves all data objects that are linked from a specific source data object. It resolves the references defined in the data model and returns all connected records.

Benefit: Processes can automatically follow data relationships — from an order to the linked customer, from a contract to the associated documents — without manual lookups.

---

How it works

In Pantarey, data structures can reference each other (e.g. "Order" references "Customer" and "Product"). When a data object is created based on such a structure, these references point to concrete data records.

This service task follows those outgoing references from a given source object and returns all targets.

Order-2026-001 ──→ Customer: Müller GmbH
                ──→ Product: Widget Pro
                ──→ Invoice: INV-2026-042

---

Input Parameters

Parameter	Type	Required	Description
dataObjectId	String	Yes	The ID of the source data object whose links should be resolved.
dataSchemaId	String	No	Filter results by a specific target data structure (e.g. only return linked "Customer" records).
includeDetails	Boolean	No	If true, enriches each reference with the target's document name and data object key. Default: false.

Example Input

{
  "dataObjectId": "550e8400-e29b-41d4-a716-446655440000",
  "dataSchemaId": "customer",
  "includeDetails": true
}

---

Output

Field	Type	Description
dataObjectId	String	The source object ID (echoed back).
totalCount	Number	Number of linked references found.
references	Array	List of linked data object references.

Each reference contains:

Field	Type	Description
sourceObjectId	String	The source object ID.
sourceObjectAttribute	String	The attribute name on the source that holds the reference.
targetObjectId	String	The ID of the linked target object.
targetDataSchemaId	String	The data structure type of the target.
sourceDataSchemaId	String	The data structure type of the source.
sourceDocumentName	String	The document name of the source object.
targetDocumentName	String / null	The document name of the target (only with includeDetails: true).
targetDataObjectKey	String / null	The data object key/path of the target (only with includeDetails: true).

Example Output

{
  "dataObjectId": "550e8400-e29b-41d4-a716-446655440000",
  "totalCount": 2,
  "references": [
    {
      "sourceObjectId": "550e8400-e29b-41d4-a716-446655440000",
      "sourceObjectAttribute": "customer",
      "targetObjectId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "targetDataSchemaId": "customer",
      "sourceDataSchemaId": "order",
      "sourceDocumentName": "Order-2026-001",
      "targetDocumentName": "Müller GmbH",
      "targetDataObjectKey": "customer/objects/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "sourceObjectId": "550e8400-e29b-41d4-a716-446655440000",
      "sourceObjectAttribute": "product",
      "targetObjectId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "targetDataSchemaId": "product",
      "sourceDataSchemaId": "order",
      "sourceDocumentName": "Order-2026-001",
      "targetDocumentName": "Widget Pro",
      "targetDataObjectKey": "product/objects/b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ]
}

---

Use Cases

• Order processing: Retrieve the customer, products, and invoice linked to an order in one step.
• Contract management: Follow a contract to its related parties, documents, and attachments.
• Impact analysis: Before modifying a record, check what other records depend on it.
• Dynamic notifications: Find all related contacts and notify them when a status changes.
• Data enrichment: Combine data from linked records into a single process variable for further processing.

---

Notes

• Without includeDetails, only the reference metadata is returned (1 database query). With includeDetails, an additional query per linked object is executed.
• If a referenced target object has been deleted, it is still included in the result but with targetDocumentName: null.
• Use dataSchemaId to narrow results when only a specific type of linked data is relevant.