ComponentService.RetrieveComponent Method

MultiArchive SDK .NET

Collapse image Expand Image Copy image CopyHover image

[This is preliminary documentation and is subject to change.]

Method for retrieving the content of a folder from MultiArchive.

The URN used for the method should be constructed in one of the following ways:
urn:multiarchive:folder:A42:/CUSTOMER/1100
urn:multiarchive:item:A42:25
urn:multiarchive:content:A42:25-1
urn:multiarchive:content:A42:25-1#5

The first URN is used for retrieving a folder to traverse its content.
The second URN is used to retrieve a specific item and is used to retrieve a file and its content.
The third URN will retrieve the content of ItemMaster 25, compound sequence 1 and implicit the latest version.
The fourth URN will retrieve the content from the same document as the third URN, but here it is explicit specified that it shall retrieve the fifth (5.) version of the document.

Namespace: MultiArchive.SDK.Services
Assembly: MultiArchive.SDK (in MultiArchive.SDK.dll) Version: 1.2.30.413 (1.2.30.413)

Syntax

C#
public Component RetrieveComponent(
	Credentials credentials,
	string componentUrn
)
Visual Basic
Public Function RetrieveComponent ( 
	credentials As Credentials,
	componentUrn As String
) As Component
Visual C++
public:
Component^ RetrieveComponent(
	Credentials^ credentials, 
	String^ componentUrn
)

Parameters

credentials
Type: Credentials
A Credentials object with information about the current user.
componentUrn
Type: System..::..String
A string representation of the Component URN for the specified Component.

Return Value

Type: Component
The method returns a Component object containing information about the folder and all its sub-folders and files.

Exceptions

Exception Condition
MultiArchive.SDK.Services.Exceptions..::..ComponentException Throws a ComponentException if any errors should occur during the SOAP communication with the MultiArchive webservice.

See Also