Asset

Description

Represents an asset in Rational Asset Manager. An asset essentially has two modes, which can be equated to GET and PUT. Use attributes for getting, and use nested elements for putting.

If you want to download an asset, or otherwise get information about it, you must specify the GUID and optionally the version as attributes of the asset. If the version attribute is omitted, the latest version of the asset is returned. If you are submitting, or putting, a new asset, omit the guid and version attributes and nest a version tag within the asset.

To modify an asset, you must specify the guid and version attributes, but you might also nest a version tag within the asset to change the version.

Parameters

Attribute Description Required
server The ID of the server that connects to Rational Asset Manager Yes, unless it is nested within an element that specified a server.
guid The GUID of an asset that exists in the Rational Asset Manager repository Yes, unless this asset is a nested element of the submit task.
version The version of an asset that is in the Rational Asset Manager repository No. Defaults to the latest version.

Parameters specified as nested elements

artifact

You can specify individual artifacts to be included in the asset.

artifactList

You can specify a list of artifacts to be included in the asset.

artifactSet

You can specify a set of artifacts to be included in the asset.

assetType

When you submit an asset, you must specify the asset type. When you modify an asset, specifying the type is optional.

attribute

You can specify individual attributes for the asset. Custom attributes might be required.

category

You can specify individual categories for the asset.

categoryList

You can specify a list of categories for the asset.

community

When you submit an asset, you must specify the community. You cannot change the community of an asset after submission.

description

You can specify a description for the asset.

name

When you submit an asset, you must specify the asset name. When you modify an asset, specifying the name is optional.

relatedAsset

You can specify individual related assets for the asset.

relatedAssetList

You can specify a list of related assets for the asset.

shortDescription

When you submit an asset, you must specify a short description. When you modify an asset, specifying the short description is optional.

tag

You can specify tags for the asset. If you specify multiple tags, separate them with spaces. Tags with spaces in them must be in double quotation marks.

version

When you submit an asset, you must specify the version. When you modify an asset, specifying the version is optional.

Examples

Submit an asset

<submit server="ramServer">
   <asset>
      <name>My Asset</name>
      <version>1.0</version>
      <community>Community A</community>
      <assetType>Component</assetType>
      <shortDescription>This is my asset!</shortDescription>
   </asset>
</submit>

Download an asset

<download server="ramServer">
   <asset guid="{0000-1111-2222-3333}" version="1.0" />
</download>

Modify the version of an asset

<modify server="ramServer">
   <asset guid="{0000-1111-2222-3333}" version="1.0">
      <version>1.1</version>
   </asset>
</modify>