Skip to main content

Get Object & Update Graph

GET 

/qlibs/:qlibid/q/:qhit/links

Example result for content hq__2ZFoswZSC9767e6dx1QMNjCJkP:

{
"root": {
"qid": "iq__4iJmtP2arpjbJSWuPreE6b",
"hash_or_token": "hq__2ZFoswZSC9767e6dx1QMNjCJkP"
},
"object_dag": {
"hq__2ZFoswZSC9767e6dx1QMNjCJkP": [
"hq__2vVWZR5TGnWr7vkC6kS4kMaWks",
"hq__3exvHew8gHqpsSRTQdfojbZQmv"
],
"hq__2vVWZR5TGnWr7vkC6kS4kMaWks": [
"hq__3HjDH4dSFt9jXk3Gr6Dz4BQGjy"
],
"hq__3HjDH4dSFt9jXk3Gr6Dz4BQGjy": [
"hq__42CciD9Snv5BVuzm4R9ZCsUFY9"
],
"hq__3exvHew8gHqpsSRTQdfojbZQmv": [
"hq__42CciD9Snv5BVuzm4R9ZCsUFY9"
],
"hq__42CciD9Snv5BVuzm4R9ZCsUFY9": []
},
"auto_updates": {
"order": [
"hq__2vVWZR5TGnWr7vkC6kS4kMaWks",
"hq__2ZFoswZSC9767e6dx1QMNjCJkP"
],
"links": {
"hq__2vVWZR5TGnWr7vkC6kS4kMaWks" : [
{
"hash": "hq__2vVWZR5TGnWr7vkC6kS4kMaWks",
"path": "/links/0",
"current": {
"/": "/qfab/hq__3HjDH4dSFt9jXk3Gr6Dz4BQGjy/meta/version",
"auto_update": {
"tag": "latest"
}
},
"updated": {
"/": "/qfab/hq__3UM4dDit6SiemZCvqaNPpqh7SF/meta/version",
"auto_update": {
"tag": "latest"
}
}
}
]
}
},
"details": {
"hq__2ZFoswZSC9767e6dx1QMNjCJkP": {
"qid": "iq__4iJmtP2arpjbJSWuPreE6b",
"meta": {
"version": "0.0"
}
},
"hq__2vVWZR5TGnWr7vkC6kS4kMaWks": {
"qid": "iq__3sduHuJWPV3qUDFoEASkiX",
"meta": {
"version": "1.0"
}
},
"hq__3HjDH4dSFt9jXk3Gr6Dz4BQGjy": {
"qid": "iq__5CzzbsoZKg1cEaktzfgqK5",
"meta": {
"version": "2.0"
}
},
"hq__3UM4dDit6SiemZCvqaNPpqh7SF": {
"qid": "iq__5CzzbsoZKg1cEaktzfgqK5",
"meta": {
"version": "2.1"
}
},
"hq__3exvHew8gHqpsSRTQdfojbZQmv": {
"qid": "iq__PV7oMAMpBk4Up9uu8mGHxU",
"meta": {
"version": "3.0"
}
},
"hq__42CciD9Snv5BVuzm4R9ZCsUFY9": {
"qid": "iq__7j9DnfTLLbJUUy6q4ibTL9",
"meta": {
"version": "4.0"
}
}
}
}

Retrieve the directed, acyclic graph (DAG) of content objects defined by absolute (inter-object) links in metadata.

If the query parameter auto_update is not set or set to false, the full DAG made up of all absolute links is returned.

If the query parameter auto_update is set to true, the DAG will only include content objects that are referenced with auto-update links. In this case, the result will include an order array that lists the content objects with pending updates in the order needed to achieve a fully updated hierarchy and details on the links that need to be updated for each object.

The query parameter update_tag allows to further restrict the selection of links to those with a matching auto-update tag. If not specified, all auto-update links are taken into account.

The details section of the result lists all content objects from the DAG with their content ID and metadata. The select and remove query parameter, which can be combined and specified multiple times, allow to restrict the returned metadata to specific items.

Failures to resolve links (e.g. caused by missing permissions to read the target content object) do not stop the processing of the request per default. Instead, resolution errors are added to a list of errors and returned in the result. In order to stop processing and fail the request if links cannot be resolved, set the query parameter ignore_errors to false.

See the metadata section for more information on links.

Request

Responses

User-defined metadata.