com.vasoftware.sf.soap44.webservices.tracker
Interface ITrackerAppSoap

public interface ITrackerAppSoap

Provides SOAP services for managing user trackers and artifacts.

Change History

Version 4.4

• getFields2: Removed in 4.4. Changes were incorporated into getFields
• setField2: Removed in 4.4. Changes were incorporated into setField
• getArtifactDetailList2: Removed in 4.4. Changes were incorporated into getArtifactDetailList, in addition to the incorporation of new features (paged data return, selection of returned columns, and sorted results).
• createArtifact2: Removed in 4.4. Changes were incorporated into createArtifact
• getArtifactData2: Removed in 4.4. Changes were incorporated into getArtifactData
• setArtifactData2: Removed in 4.4. Changes were incorproated into setArtifactData
• setField: New exception added in 4.4: DependencyViolationFault
• getArtifactList: Added a limit to the number of rows that could be retreived. This limit is by default 5000 but is configurable
• getChildDependencyList: New operation added in 4.4
• createArtifactDependency: New operation added in 4.4
• getParentdDependencyList: New operation added in 4.4
• removeArtifactDependency: New operation added in 4.4

Since:

4.1

Method Summary

void	addDateField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate) Adds a custom Date field to a tracker.
void	addMultiSelectField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, java.lang.String[] fieldValues, java.lang.String[] defaultValues) Adds a custom multi select field to a tracker.
void	addSingleSelectField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, java.lang.String[] fieldValues, java.lang.String defaultValue) Adds a custom single select field to a tracker.
void	addTextField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, java.lang.String defaultValue) Adds a custom text field to a tracker.
void	addUserSelectField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, java.lang.String[] defaultValues, java.lang.String userFilter) Adds a custom User selection field to a tracker.
void	copyWorkflowTransitions(java.lang.String sessionId, java.lang.String srcTrackerId, java.lang.String dstTrackerId) Copy workflow transitions between two trackers.
ArtifactSoapDO	createArtifact(java.lang.String sessionId, java.lang.String trackerId, java.lang.String title, java.lang.String description, java.lang.String group, java.lang.String category, java.lang.String status, java.lang.String customer, int priority, int estimatedHours, java.lang.String assignedUsername, java.lang.String releaseId, com.vasoftware.sf.soap44.types.SoapFieldValues flexFields, java.lang.String attachmentFileName, java.lang.String attachmentMimeType, java.lang.String attachmentFileId) Creates a new artifact.
void	createArtifactDependency(java.lang.String sessionId, java.lang.String originId, java.lang.String targetId, java.lang.String desc) Create an artifact dependency between two artifacts.
TrackerSoapDO	createTracker(java.lang.String sessionId, java.lang.String projectId, java.lang.String trackerName, java.lang.String trackerTitle, java.lang.String trackerDescription) Creates a new tracker
void	deleteArtifact(java.lang.String sessionId, java.lang.String artifactId) Deletes an artifact.
void	deleteField(java.lang.String sessionId, java.lang.String objectId, java.lang.String fieldId) Delete a custom/flex-field .
ArtifactSoapList	findArtifacts(java.lang.String sessionId, java.lang.String queryString, java.lang.String projectId, boolean searchAttachments) Finds a list of artifacts matching a search string.
WorkflowTransitionSoapList	getAllowedWorkflowTransitionList(java.lang.String sessionId, java.lang.String trackerId) Get workflow transitions for the tracker.
ArtifactSoapDO	getArtifactData(java.lang.String sessionId, java.lang.String artifactId) Returns data associated with the specified artifact.
ArtifactDetailSoapList	getArtifactDetailList(java.lang.String sessionId, java.lang.String trackerId, java.lang.String[] selectedColumns, SoapFilter[] filters, com.vasoftware.sf.soap44.types.SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) Returns a filtered and ordered list of artifacts from the specified tracker.
ArtifactSoapList	getArtifactList(java.lang.String sessionId, java.lang.String containerId, SoapFilter[] filters) Returns a filtered list of artifacts within the specified container (project or tracker).
ArtifactDependencySoapList	getChildDependencyList(java.lang.String sessionId, java.lang.String artifactId) Get the dependency list for an artifact where the artifact is the origin artifact.
TrackerFieldSoapDO[]	getFields(java.lang.String sessionId, java.lang.String trackerId) Returns the custom/flex-fields associated with a specific tracker.
ArtifactDependencySoapList	getParentDependencyList(java.lang.String sessionId, java.lang.String artifactId) Get the dependency list for an artifact where the artifact is the target artifact.
TrackerSoapDO	getTrackerData(java.lang.String sessionId, java.lang.String trackerId) Returns a data object for a given tracker
TrackerSoapList	getTrackerList(java.lang.String sessionId, java.lang.String projectId) Returns a list of trackers for a project.
ArtifactSoapDO	moveArtifact(java.lang.String sessionId, java.lang.String artifactId, java.lang.String targetFolderId, java.lang.String newAssignee) Moves an artifact to a specified target folder.
void	removeArtifactDependency(java.lang.String sessionId, java.lang.String originId, java.lang.String targetId) Remove an artifact dependency between two artifacts.
void	setArtifactData(java.lang.String sessionId, ArtifactSoapDO artifactData, java.lang.String comment, java.lang.String attachmentFileName, java.lang.String attachmentMimeType, java.lang.String attachmentFileId) Sets data associated with the specified artifact.
void	setField(java.lang.String sessionId, java.lang.String objectId, TrackerFieldSoapDO fieldData) Sets a custom/flex-field that is associated with a specific folder (e.g. tracker).
void	setTrackerData(java.lang.String sessionId, TrackerSoapDO trackerData) Sets data on a specific tracker

Method Detail

getTrackerList

TrackerSoapList getTrackerList(java.lang.String sessionId,
                               java.lang.String projectId)
                               throws java.rmi.RemoteException

Returns a list of trackers for a project.

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

List of trackers within the project.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getTrackerData

TrackerSoapDO getTrackerData(java.lang.String sessionId,
                             java.lang.String trackerId)
                             throws java.rmi.RemoteException

Returns a data object for a given tracker

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

Detailed data on the tracker.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insuficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

"4.2"

setTrackerData

void setTrackerData(java.lang.String sessionId,
                    TrackerSoapDO trackerData)
                    throws java.rmi.RemoteException

Sets data on a specific tracker

Parameters:

sessionId - User session id.

trackerData - Detailed data on the tracker to set.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when invalid data is specified.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - when the object version mismatches the application server.

java.rmi.RemoteException

Since:

4.2

createTracker

TrackerSoapDO createTracker(java.lang.String sessionId,
                            java.lang.String projectId,
                            java.lang.String trackerName,
                            java.lang.String trackerTitle,
                            java.lang.String trackerDescription)
                            throws java.rmi.RemoteException

Creates a new tracker

Parameters:

sessionId - User session id.

projectId - The id of the project under which to create the new tracker

trackerName - The name of the new tracker

trackerTitle - The title of the new tracker

trackerDescription - The description of the new tracker

Returns:

the tracker soap object

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.ObjectAlreadyExistsFault - if an existing tracker already exists

java.rmi.RemoteException

Since:

4.3-HOTFIX1

setField

void setField(java.lang.String sessionId,
              java.lang.String objectId,
              TrackerFieldSoapDO fieldData)
              throws java.rmi.RemoteException

Sets a custom/flex-field that is associated with a specific folder (e.g. tracker).

Parameters:

sessionId - User session id.

objectId - Object (e.g. tracker) for which to set the field information.

fieldData - the custom/flex-field to associate with a specific folder

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified. See FaultSummary for detail for the following: - DUPLICATE_FIELD_VALUE - ILLEGAL_FIELD_VALUE - INVALID_FIELD_VALUE - INVALID_DEFAULT_VALUE - INVALID_FIELD_OPTIONS_REQUIRED_DISABLED - INVALID_FIELD_VALUE_LENGTH - REQUIRED_FIELD_MISSING

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed. See FaultSummary for detail for the following: - INVALID_OPTION_DISABLE_RESERVED_FIELD - INVALID_OPTION_DISABLE_IN_USE_FIELD

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.DependencyViolationFault - if changing a status violates artifact dependency

java.rmi.RemoteException

Since:

4.3-HOTFIX1

See Also:

FaultSummary

addTextField

void addTextField(java.lang.String sessionId,
                  java.lang.String trackerId,
                  java.lang.String fieldName,
                  int displayColumns,
                  int displayLines,
                  boolean isRequired,
                  boolean isDisabled,
                  boolean isHiddenOnCreate,
                  java.lang.String defaultValue)
                  throws java.rmi.RemoteException

Adds a custom text field to a tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the field to.

fieldName - the name of the field

displayColumns - the width of the display area

displayLines - the height of the display area

isRequired - if the field is required

isDisabled - if the field is disabled

isHiddenOnCreate - if the field is hidden when first created

defaultValue - default value

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

addSingleSelectField

void addSingleSelectField(java.lang.String sessionId,
                          java.lang.String trackerId,
                          java.lang.String fieldName,
                          boolean isRequired,
                          boolean isDisabled,
                          boolean isHiddenOnCreate,
                          java.lang.String[] fieldValues,
                          java.lang.String defaultValue)
                          throws java.rmi.RemoteException

Adds a custom single select field to a tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the field to.

fieldName - the name of the field

isRequired - if the field is required

isDisabled - if the field is disabled

isHiddenOnCreate - if the field is hidden when first created

fieldValues - Array of valid field values

defaultValue - default value

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

addMultiSelectField

void addMultiSelectField(java.lang.String sessionId,
                         java.lang.String trackerId,
                         java.lang.String fieldName,
                         int displayLines,
                         boolean isRequired,
                         boolean isDisabled,
                         boolean isHiddenOnCreate,
                         java.lang.String[] fieldValues,
                         java.lang.String[] defaultValues)
                         throws java.rmi.RemoteException

Adds a custom multi select field to a tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the field to.

fieldName - the name of the field

displayLines - the height of the display area

isRequired - if the field is required

isDisabled - if the field is disabled

isHiddenOnCreate - if the field is hidden when first created

fieldValues - possible values

defaultValues - default values

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

addUserSelectField

void addUserSelectField(java.lang.String sessionId,
                        java.lang.String trackerId,
                        java.lang.String fieldName,
                        int displayLines,
                        boolean isRequired,
                        boolean isDisabled,
                        boolean isHiddenOnCreate,
                        java.lang.String[] defaultValues,
                        java.lang.String userFilter)
                        throws java.rmi.RemoteException

Adds a custom User selection field to a tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the field to.

fieldName - the name of the field

displayLines - the height of the display area

isRequired - if the field is required

isDisabled - if the field is disabled

isHiddenOnCreate - if the field is hidden when first created

defaultValues - default values for this field. Must be valid usernames

userFilter - is the filter

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-SP1

See Also:

TrackerFieldSoapDO.FIELD_USER_FILTER_PROJECT_MEMBER, TrackerFieldSoapDO.FIELD_USER_FILTER_ALL

addDateField

void addDateField(java.lang.String sessionId,
                  java.lang.String trackerId,
                  java.lang.String fieldName,
                  boolean isRequired,
                  boolean isDisabled,
                  boolean isHiddenOnCreate)
                  throws java.rmi.RemoteException

Adds a custom Date field to a tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the field to.

fieldName - the name of the field

isRequired - if the field is required

isDisabled - if the field is disabled

isHiddenOnCreate - if the field is hidden when first created

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-SP1

deleteField

void deleteField(java.lang.String sessionId,
                 java.lang.String objectId,
                 java.lang.String fieldId)
                 throws java.rmi.RemoteException

Delete a custom/flex-field .

Parameters:

sessionId - User session id.

objectId - Object (e.g. tracker).

fieldId - the id of the field to delete

Throws:

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.InvalidOperationFault - if the operation is not allowed.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

getFields

TrackerFieldSoapDO[] getFields(java.lang.String sessionId,
                               java.lang.String trackerId)
                               throws java.rmi.RemoteException

Returns the custom/flex-fields associated with a specific tracker.

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all field values.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

getArtifactList

ArtifactSoapList getArtifactList(java.lang.String sessionId,
                                 java.lang.String containerId,
                                 SoapFilter[] filters)
                                 throws java.rmi.RemoteException

Returns a filtered list of artifacts within the specified container (project or tracker). See ArtifactSoapDO for filter constant values: ArtifactSoapDO.FILTER_ASSIGNED_TO, etc.

Change History

Version 4.2

• Added additional parameter (filters) for filtering artifact lists.

Version 4.4

• Added a limit to the number of rows that could be retreived. This limit is by default 5000 but is configurable
• it is substantially obselete by enhancements to getArtifactDetailList(), which now includes the ability to select which columns are returned, as well as the ability to fetch subsets of data on a "paged" basis, and to return sorted results.

Parameters:

sessionId - User session id.

containerId - ID of a project or a tracker.

filters - Array of filters to apply (null to return unfiltered list).

Returns:

List of filtered artifacts.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.InvalidFilterFault - when the specified filters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getArtifactDetailList

ArtifactDetailSoapList getArtifactDetailList(java.lang.String sessionId,
                                             java.lang.String trackerId,
                                             java.lang.String[] selectedColumns,
                                             SoapFilter[] filters,
                                             com.vasoftware.sf.soap44.types.SoapSortKey[] sortKeys,
                                             int startIndex,
                                             int maxRows,
                                             boolean exceptionIfExpiredCache,
                                             boolean forceNewQuery)
                                             throws java.rmi.RemoteException

Returns a filtered and ordered list of artifacts from the specified tracker. It gives the user the ability to ask only for certain results with the parameters startIndex and maxRows. In this way the method can be used to implement paging. A special value of -1 for the maxRows parameter will be interpreted as asking for the complete list, ignoring the value in startIndex.

This method makes use of server-side caching of the complete list in order to more efficiently return results for requests for subsequent "pages" of data. In normal usage, requesting a subsequent page of a given list will return data from this cache unless the cache has expired, in which case the query will transparently be re-executed before return the results. Note that this transparent re-execution can result in slight inconsistencies in the data, if the underlying data has changed. The exceptionIfExpiredCache and forceNewQuery flags can be used to tune cache behavior.

Caching is managed transparently by the application server, using the filters and selectedColumns parameters to identify subsequent requests for subsets of the same data set. The cache is associated with the user session. Note that the implementation may choose not to cache results if the entire list is being fetched (via specifying -1 for maxRows).

Note: You can't sort or filter by a non selected column.

See ArtifactSoapDO for column and filter names constant values: ArtifactSoapDO.COLUMN_TITLE, ArtifactSoapDO.COLUMN_ASSIGNED_TO, FILTER_PRIORITY, FILTER, FILTER_CATEGORY, etc.

Parameters:

sessionId - User session id.

trackerId - Tracker id.

selectedColumns - String array of column names to be selected (null to return all columns). See ArtifactSoapDO for column names constant values e.g. ArtifactSoapDO.COLUMN_CATEGORY

filters - Array of filters to apply (null to return unfiltered list). See ArtifactSoapDO for filters names constant values e.g. ArtifactSoapDO.FILTER_PRIORITY

sortKeys - Array of SortKey to apply (null to return a default order list that is by ID). See ArtifactSoapDO for column names constant values e.g. ArtifactSoapDO.COLUMN_PRIORITY

startIndex - The index from which to return the results.

maxRows - The max quantity of elements to be returned (-1 will return the full list).

exceptionIfExpiredCache - Causes the method to throw an exception if it doesn't have the results in the cache, rather than the default behavior of silently re-executing the query. This can be used if the caller is fetching paged data and wants to be assured that the pages are from one consistent snapshot of the data.

forceNewQuery - force the re-execution of the query, ignoring any cached copy of the search result.

Returns:

List of filtered artifacts.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.InvalidFilterFault - when the specified filters are invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1 Heavily modified in 4.4 to add paging, sorting and column selection.

findArtifacts

ArtifactSoapList findArtifacts(java.lang.String sessionId,
                               java.lang.String queryString,
                               java.lang.String projectId,
                               boolean searchAttachments)
                               throws java.rmi.RemoteException

Finds a list of artifacts matching a search string.

Parameters:

sessionId - User session id.

queryString - Query string.

projectId - The project in which to find artifacts. (if null, search all projects)

searchAttachments - Whether to search attachments.

Returns:

List of artifacts matching search criteria.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified project id is invalid.

com.vasoftware.sf.soap44.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when the specified query string is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.1

getArtifactData

ArtifactSoapDO getArtifactData(java.lang.String sessionId,
                               java.lang.String artifactId)
                               throws java.rmi.RemoteException

Returns data associated with the specified artifact.

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

the data associated with the artifact at the given path

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

setArtifactData

void setArtifactData(java.lang.String sessionId,
                     ArtifactSoapDO artifactData,
                     java.lang.String comment,
                     java.lang.String attachmentFileName,
                     java.lang.String attachmentMimeType,
                     java.lang.String attachmentFileId)
                     throws java.rmi.RemoteException

Sets data associated with the specified artifact.

Change History

Version 4.2

• Added additional paramters for an attachment.

Parameters:

sessionId - User session id.

artifactData - the data associated with the artifact at the given path

comment - Comment associated with the change.

attachmentFileName - Name of the attached file (or null)

attachmentMimeType - Mime type of the attached file (or null)

attachmentFileId - ID of the attached file (previously uploaded via *FileStorage service) or null

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.VersionMismatchFault - when the object data is stale.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when the artifact data is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when workflow rule is violated

com.vasoftware.sf.soap44.fault.DependencyViolationFault - when dependency rule is violated

java.rmi.RemoteException

Since:

4.1

createArtifact

ArtifactSoapDO createArtifact(java.lang.String sessionId,
                              java.lang.String trackerId,
                              java.lang.String title,
                              java.lang.String description,
                              java.lang.String group,
                              java.lang.String category,
                              java.lang.String status,
                              java.lang.String customer,
                              int priority,
                              int estimatedHours,
                              java.lang.String assignedUsername,
                              java.lang.String releaseId,
                              com.vasoftware.sf.soap44.types.SoapFieldValues flexFields,
                              java.lang.String attachmentFileName,
                              java.lang.String attachmentMimeType,
                              java.lang.String attachmentFileId)
                              throws java.rmi.RemoteException

Creates a new artifact.

Change History

Version 4.2

• Added additional paramters for an attachment.

Parameters:

sessionId - User session id.

title - Artifact title.

description - Artifact description.

group - Artifact group.

category - Artifact category.

status - Artifact status.

customer - Customer.

priority - Artifact priority.

estimatedHours - Estimated hours to close artifact.

assignedUsername - User this artifact should be assigned to.

releaseId - Relase this artifact is assigned with.

flexFields - Flex field values.

trackerId - Tracker id.

attachmentFileName - Name of the attached file (or null)

attachmentMimeType - Mime type of the attached file (or null)

attachmentFileId - ID of the attached file (previously uploaded via *FileStorage service) or null

Returns:

Newly created artifact object.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when the artifact data is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

moveArtifact

ArtifactSoapDO moveArtifact(java.lang.String sessionId,
                            java.lang.String artifactId,
                            java.lang.String targetFolderId,
                            java.lang.String newAssignee)
                            throws java.rmi.RemoteException

Moves an artifact to a specified target folder.

Parameters:

sessionId - User session id.

artifactId - ID of artifact to move.

targetFolderId - Target folder ID.

newAssignee - The username to assign the newly moved artifact to.

Returns:

New artifact data object

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the sessionId is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system error occurs.

com.vasoftware.sf.soap44.fault.IllegalArgumentFault - when an invalid argument is passed in.

java.rmi.RemoteException

Since:

4.2

deleteArtifact

void deleteArtifact(java.lang.String sessionId,
                    java.lang.String artifactId)
                    throws java.rmi.RemoteException

Deletes an artifact.

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.1

getAllowedWorkflowTransitionList

WorkflowTransitionSoapList getAllowedWorkflowTransitionList(java.lang.String sessionId,
                                                            java.lang.String trackerId)
                                                            throws java.rmi.RemoteException

Get workflow transitions for the tracker.

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

Workflow definitions list. For requiredFields property of workflow definition, following special field IDs are used (in addition to standard field definitions in ArtifactSoapDO): "comment", "attachment", "assignedTo", "priority".

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.SystemFault - when ...

java.rmi.RemoteException

Since:

4.3

copyWorkflowTransitions

void copyWorkflowTransitions(java.lang.String sessionId,
                             java.lang.String srcTrackerId,
                             java.lang.String dstTrackerId)
                             throws java.rmi.RemoteException

Copy workflow transitions between two trackers. In order for this operation to succeed, the following conditions must be met: - caller needs to have tracker admin permission for both srTracker and destTracker - every transition req role in srcTracker must have corresponding role with the same name in dstTracker - every transition req field in srcTracker must have corresponding field with the same name in dstTracker or be a custom field name.

Parameters:

sessionId - User session id.

srcTrackerId - Tracker id.

dstTrackerId - Tracker id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.3-SP1-HOTFIX3

createArtifactDependency

void createArtifactDependency(java.lang.String sessionId,
                              java.lang.String originId,
                              java.lang.String targetId,
                              java.lang.String desc)
                              throws java.rmi.RemoteException

Create an artifact dependency between two artifacts. If an existing artifact dependency already exists, the descriptions are simply overriden.

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

desc - Description for the dependency.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.vasoftware.sf.soap44.fault.DependencyViolationFault - when the creation of the dependency causes violation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.4

removeArtifactDependency

void removeArtifactDependency(java.lang.String sessionId,
                              java.lang.String originId,
                              java.lang.String targetId)
                              throws java.rmi.RemoteException

Remove an artifact dependency between two artifacts.

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.vasoftware.sf.soap44.fault.DependencyViolationFault - when the creation of the dependency causes violation

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

com.vasoftware.sf.soap44.fault.NoSuchRelationshipFault - when ...

java.rmi.RemoteException

Since:

4.4

getChildDependencyList

ArtifactDependencySoapList getChildDependencyList(java.lang.String sessionId,
                                                  java.lang.String artifactId)
                                                  throws java.rmi.RemoteException

Get the dependency list for an artifact where the artifact is the origin artifact.

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

dependency list

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.4

getParentDependencyList

ArtifactDependencySoapList getParentDependencyList(java.lang.String sessionId,
                                                   java.lang.String artifactId)
                                                   throws java.rmi.RemoteException

Get the dependency list for an artifact where the artifact is the target artifact. While in 4.4, an artifact can only have a single parent, that can be changed in future releases.

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

dependency list

Throws:

com.vasoftware.sf.soap44.fault.InvalidSessionFault - when the specified session id is invalid.

com.vasoftware.sf.soap44.fault.NoSuchObjectFault - when the specified object id is invalid.

com.vasoftware.sf.soap44.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.vasoftware.sf.soap44.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.vasoftware.sf.soap44.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.4