list_link_definitions
Retrieve entry-link type definitions from the repository, providing linkTypeId, sourceLabel, and targetLabel needed for set_links.
Instructions
List the entry-link type definitions available on this repository.
Use before calling set_links — you need a linkTypeId from
this listing to construct a valid link. Each link type is directed:
it has a sourceLabel (how the relationship reads from the source
entry) and a targetLabel (how it reads from the target).
Args:
max_results: Page size (default 25).
skip: 0-indexed offset for pagination.
summary_only: If True, return only {count, names}.
Returns: Server's raw OData listing with value. Each item has
linkTypeId, sourceLabel, targetLabel, and
linkTypeDescription. Common defaults include "Supersedes" / "Superseded by" and "Attachment" / "Message".
On failure: returns {"mode": "error", "error": <slug>, ...}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| max_results | No | Page size (default 25, capped by LF_MAX_RESULTS_CEILING). | |
| skip | No | 0-indexed offset for pagination through large repositories. | |
| summary_only | No | When True, return only {count, names} instead of the full OData listing — useful for 'what's available?' lookups that would otherwise return 30-50 KB of definition payload. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||