Platform Explorer / Nuxeo Platform LTS 2015 7.10

Operation Document.GetLinkedDocuments

Get Linked Documents

Description

Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.
Operation id Document.GetLinkedDocuments
AliasesRelations.GetRelations
Category Services
Label Get Linked Documents
Requires
Since

Parameters

Name Description Type Required Default value
predicate string yes  
graphName string no  
outgoing boolean no  

Signature

Inputs document
Outputs documents

Implementation information

Implementation class org.nuxeo.ecm.automation.core.operations.services.GetRelations
Contributing component org.nuxeo.ecm.core.automation.featuresContrib

JSON definition

{
  "id" : "Document.GetLinkedDocuments",
  "aliases" : [ "Relations.GetRelations" ],
  "label" : "Get Linked Documents",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.",
  "url" : "Document.GetLinkedDocuments",
  "signature" : [ "document", "documents" ],
  "params" : [ {
    "name" : "predicate",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "graphName",
    "description" : "",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "outgoing",
    "description" : "",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}