IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get shareable references API
editGet shareable references API
edit[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Get shareable references.
Collects references and spaces context for saved objects.
Request
editPOST <kibana host>:<port>/api/spaces/_get_shareable_references
Request body
edit-
objects -
(Required, object array) The saved objects to collect outbound references for.
Properties of
objects-
type - (Required, string) The saved object type.
-
id - (Required, string) The saved object ID.
-
Response body
edit-
objects -
(object array) The returned input object or one of its references, with additional context.
Properties of
objects-
type - (string) The saved object type.
-
id - (string) The saved object ID.
-
originId - (string) The origin ID of the referenced object (if it has one).
-
inboundReferences -
(object array) References to this object.
This does not contain all inbound references everywhere, it only contains inbound references to this object within the scope of this operation.
Properties of
inboundReferences-
type - (string) The type of the object that has the inbound reference.
-
id - (string) The ID of the object that has the inbound reference.
-
name - (string) The name of the inbound reference.
-
-
spaces - (string array) The space(s) that the referenced saved object exists in.
-
spacesWithMatchingAliases - (string array) The space(s) that legacy URL aliases matching this type/id exist in. (if there are any)
-
spacesWithMatchingOrigins - (string array) The space(s) that objects matching this origin exist in (including this one). (if there are any)
-
isMissing - (boolean) Whether or not this object or reference is missing.
-