Skip to main content
GET
/
links
Error
A valid request URL is required to generate request examples
[
  {
    "subject": {
      "type": "APPKIT_APP",
      "id": "<string>",
      "canonicalName": "<string>",
      "uri": "<string>"
    },
    "object": {
      "type": "APPKIT_APP",
      "id": "<string>",
      "canonicalName": "<string>",
      "uri": "<string>"
    },
    "linkType": "DependsOn",
    "originator": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
subject
string
default:*

Return only links with a matching subject

​
object
string
default:*

Return only links with a matching object

​
linkType
string
default:*

Return only links with a matching type

​
transitive
boolean
default:false

Return transitive links

​
bypassCache
boolean
default:false

Bypass the cache and retrieve directly from storage

Response

200 - application/json

successful operation

​
subject
object
​
object
object
​
linkType
enum<string>
read-only
Available options:
DependsOn,
Supports,
IsPartOf,
HasPart,
RelatesTo,
InContextOf,
HasContext,
Self
​
originator
string
read-only