GetReferences Method

Connection GetReferences Method

BlueCielo Meridian Connection API 2013 Reference Guide | BlueCielo ECM Solutions

Returns a variant array of object IDs for all references of a document according to a defined reference type.

Namespace: ICMeridianAPI
Assembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 1.0.6.0 (1.0.6.0)

Syntax

public Object[] GetReferences(
	string vaultidentifier,
	string docid,
	string reftypename,
	bool bIncoming = false
)

public Object[] GetReferences(
	string vaultidentifier,
	string docid,
	string reftypename,
	bool bIncoming = false
)

Public Function GetReferences ( _
	vaultidentifier As String, _
	docid As String, _
	reftypename As String, _
	Optional bIncoming As Boolean = False _
) As Object()

Public Function GetReferences ( _
	vaultidentifier As String, _
	docid As String, _
	reftypename As String, _
	Optional bIncoming As Boolean = False _
) As Object()

public:
array<Object^>^ GetReferences(
	String^ vaultidentifier, 
	String^ docid, 
	String^ reftypename, 
	bool bIncoming = false
)

public:
array<Object^>^ GetReferences(
	String^ vaultidentifier, 
	String^ docid, 
	String^ reftypename, 
	bool bIncoming = false
)

Parameters

vaultidentifier: Type: System String
The vault in which the document resides.

docid: Type: System String
The unique identifier of the document inside the vault.

reftypename: Type: System String
The internal or display name of the document reference type that is used to define the relationship.

bIncoming (Optional): Type: System Boolean
If bIncoming is False, the docid is the source document of the reference. If bIncoming is True, the docid is the destination of the reference.

Return Value

Array of IDs of documents the refs exist from the specified document (or to it if bIncoming is specified as True)

Remarks