API for Artifacts

Part of the Object based program API.

class ArtifactApi

Returned by

CreateLocalArtifactReference(filePath, namespace=None)

Creates a new LocalArtifactReference.

Parameters:
filePath : str

Path of the file.

namespace : str

Identifier of the workspace to which a relative filePath is resolved. If not present or None, the namespace is determined automatically. It is also possible to reference a library workspace using its namespace. A relative filePath is resolved relative to the parameters directory of the given namespace. For example, the namespace parameter ‘myLibrary’ results in ‘<libraries.myLibrary.parameters>/MyMapping.xam’.

Returns:

LocalArtifactReference object.

Return type:

LocalArtifactReference

CreateTestGuideArtifactReference(depositoryName, artifactId, artifactName)

Creates a new TestGuideArtifactReference.

Parameters:
depositoryName : str

Name of the depository as defined in the workspace settings.

artifactId : str

ID of the artifact in the depository.

artifactName : str

Name of the artifact (including extension).

Returns:

TestGuideArtifactReference object.

Return type:

TestGuideArtifactReference