Download
The Download command downloads the specified document to a target location on the client machine.
Command-Line Syntax
java —jar RBMWebServiceCore.jar —ServiceName Download —ContainerType —ContainerName —ObjectType —Target [—ObjectName] [—Location] [—Iteration] [—Revision] [—Criteria]
Arguments with an asterisk (*) are mandatory.
|
Argument
|
Description
|
|---|---|
|
—ContainerType*
|
One of LIBRARY, PRODUCT, or PROJECT.
|
|
—ContainerName*
|
Name of the container.
|
|
—ObjectType*
|
Type of the object to be fetched. The object type could be one of SWBuild, SWDocument, or SWConfData.
|
|
—ObjectName
|
Name of the object.
|
|
—Target*
|
Destination folder of the downloaded document.
|
|
—Location
|
Location of the object in the specified container.
|
|
—Iteration
|
Iteration ID of the object to be downloaded. Specify LATEST to download the latest iteration.
If you want to use —Criteria , use the property iterationInfo.identifier.iterationId.
|
|
—Revision
|
Revision ID of the object to be downloaded. Specify LATEST to download the latest revision.
If you want to use —Criteria , use the property versionInfo.identifier.versionId.
|
|
—Criteria
|
Criteria to find the object or the container.
|
 |
This command fails if multiple objects are returned using the specified arguments.
|
Configuration File Template
<service>
<ServiceName>Download</ServiceName>
<ContainerType>...</ContainerType>
<ContainerName>...</ContainerName>
<ObjectType>...</ObjectType>
<ObjectName>...</ObjectName>
<Target>...</Target>
<Location>...</Location>
<Iteration>...</Iteration>
<Revision>...</Revision>
<Criteria>...</Criteria>
</service>
<ServiceName>Download</ServiceName>
<ContainerType>...</ContainerType>
<ContainerName>...</ContainerName>
<ObjectType>...</ObjectType>
<ObjectName>...</ObjectName>
<Target>...</Target>
<Location>...</Location>
<Iteration>...</Iteration>
<Revision>...</Revision>
<Criteria>...</Criteria>
</service>
Example
• To download a specific iteration and a revision of a software build object in a specific folder of a container, type:
java —jar RBMWebServiceCore.jar —ServiceName Download —ContainerType PRODUCT —ContainerName GOLF_CART —ObjectType SWBuild —ObjectName TestSWBld3 —Location Test Folder —Iteration 7 —Revision A —Target D:\temp
• To download a software build object of the latest iteration and revision in a specific folder of a container, type:
java —jar RBMWebServiceCore.jar —ServiceName Download —ContainerType PRODUCT —ContainerName GOLF_CART —ObjectType SWBuild —ObjectName TestSWBld3 —Location Test Folder —Iteration LATEST —Revision LATEST —Target D:\temp
• To download a software build object in a specific container with a criteria number, type:
java —jar RBMWebServiceCore.jar —ServiceName Download —ContainerType PRODUCT —ContainerName GOLF_CART —ObjectType SWBuild —Target D:\temp —Criteria "number=00201&versionInfo.identifier.versionId='B'&iterationInfo.identifier.iterationId=2"
• To download a software build object of a specific name and revision from a specific container, type:
java —jar RBMWebServiceCore.jar —ServiceName Download —ContainerType PRODUCT —ContainerName GOLF_CART —ObjectType SWBuild —Target D:\temp —Criteria name='Test Build 01' —Revision A