com.collabnet.ce.soap60.webservices.tracker
Interface ITrackerAppSoap

public interface ITrackerAppSoap

Provides SOAP services for managing user trackers and artifacts.

Change History

Version 6.1

• getTracker2List: Removed and merged into getTrackerList.
• getTracker2Data: Removed and merged into getTrackerData.
• setTracker2Data: Removed and merged into setTrackerData.
• createTracker2: Removed and merged into createTracker.
• setField3, setField2: Removed and merged into setField.
• getFields3, getFields2: Removed and merged into getFields.
• addTextField2: Removed and merged into addTextField.
• addSingleSelectField2: Removed and merged into addSingleSelectField.
• addMultiSelectField2: Removed and merged into addMultiSelectField.
• addUserSelectField2: Removed and merged into addUserSelectField.
• addDateField2: Removed and merged into addDateField.
• getArtifactList3, getArtifactList2: Removed and merged into getArtifactList.
• getArtifactDetailList3, getArtifactDetailList2: Removed and merged into getArtifactDetailList.
• findArtifacts3, findArtifacts2: Removed and merged into findArtifacts.
• getArtifactData3, getArtifactData2: Removed and merged into getArtifactData.
• setArtifactData3, setArtifactData2: Removed and merged into setArtifactData.
• moveArtifact3, moveArtifact2: Removed and merged into moveArtifact.
• copyWorkflowTransitions2: Removed and merged into copyWorkflowTransitions.
• getChildDependency2List: Removed and merged into getChildDependencyList.
• getParentDependency2List: Removed and merged into getParentDependencyList.
• createArtifact3, createArtifact2: Removed and merged into createArtifact.
• getCrossTrackerArtifactList2: Removed and merged into getCrossTrackerArtifactList.

Version 5.4.1

• setField3: Added to 5.4.1 to accommodate new help text, pattern fields and field hierarchy.
• addTextField2: Added to 5.4.1 to accommodate new help text and pattern fields.
• addSingleSelectField2: Added to 5.4.1 to accommodate new help text field.
• addSingleSelectChildField: Added to 5.4.1 to create single select field specifying its parent.
• addMultiSelectField2: Added to 5.4.1 to accommodate new help text field.
• addUserSelectField2: Added to 5.4.1 to accommodate new help text field.
• addDateField2: Added to 5.4.1 to accommodate new help text field.
• getFields3: Added to 5.4.1 to accommodate new help text, pattern fields and field hierarchy.
• addSeparator: Added to 5.4.1 to add a separator in a tracker.
• deleteSeparator: Added to 5.4.1 to delete a separator in a tracker.
• getOrderedTrackerFields: Added to 5.4.1 to get ordered list of fields and separators in a tracker.
• reorderTrackerFields: Added to 5.4.1 to reorder list of fields and separators in a tracker.

Version 5.4

• reorderTrackers: Added to 5.4 to reorder the way the trackers are displayed.
• setArtifactRank: Added to 5.4 to rank artifacts in a planning folder.
• createArtifact3: Added to 5.4 to accommodate new points field.
• getArtifactData3: Added to 5.4 to accommodate new points field.
• setArtifactData3: Added to 5.4 to accommodate new points field.
• moveArtifacts3: Added to 5.4 to accommodate new points field.
• getArtifactList3: Added to 5.4 to accommodate new points field.
• getArtifactDetailList3: Added to 5.4 to accommodate new points field and to support filtering on the release fields.
• findArtifacts3: Added to 5.4 to accommodate new points field.
• getCrossTrackerArtifactList2: Added to 5.4 to accommodate new points field.

Version 5.3

• createTracker2: Added back in 5.3 to return new Tracker2Soap objects.
• getTracker2Data: Added back in 5.3 to return new Tracker2Soap objects.
• setTracker2Data: Added back in 5.3 work with new Tracker2Soap objects.
• getTracker2List: Added back in 5.3 work with new Tracker2SoapList objects.
• getCrossTrackerArtifactList: Added in 5.3 to return new ArtifactDetail2SoapList objects.
• getArtifactDetailList2: Added back in 5.3 to return new ArtifactDetail2SoapList objects.
• getChildDependency2List: Added back in 5.3 to return new TrackerArtifactDependency2List.
• getParentDependency2List: Added back in 5.3 to return new TrackerArtifactDependency2List.
• getArtifactList2: Added back in 5.3 to return new Artifact2SoapList objects.
• createArtifact2: Added back in 5.3 to accommodate new effort fields.
• getArtifactData2: Added back in 5.3 to return new Artifact2SoapDO object.
• setArtifactData2: Added back in 5.3 to work with new Artifact2SoapDO objects.
• setField2: Added back in 5.3 to work with new TrackerField2SoapDO objects.
• getFields2: Added back in 5.3 to work with new TrackerField2SoapDO objects.
• copyWorkflowTransitions2: Added to 5.3.
• findArtifacts2: Added to 5.3 to return new Artifact2SoapDO objects.
• moveArtifacts2: Added to 5.3 to work with new Artifact2SoapDO objects.
• All methods taking SoapFilter
arguments now support ORing filter conditions if multiple SoapFilter objects with the same name but different values are passed.
• New filter constants Artifact2SoapDO.FILTER_PLANNING_FOLDER_ID, Artifact2SoapDO.FILTER_MODIFIED_BEFORE, Artifact2SoapDO.FILTER_MODIFIED_AFTER, Artifact2SoapDO.FILTER_SUBMITTED_BEFORE, Artifact2SoapDO.FILTER_SUBMITTED_AFTER, Artifact2SoapDO.FILTER_CUSTOMER, Artifact2SoapDO.FILTER_GROUP, Artifact2SoapDO.FILTER_TITLE, Artifact2SoapDO.FILTER_REPORTED_IN_RELEASE_TITLE, Artifact2SoapDO.FILTER_RESOLVED_IN_RELEASE_TITLE, Artifact2SoapDO.FILTER_REMAINING_EFFORT Artifact2SoapDO.FILTER_ACTUAL_EFFORT, Artifact2SoapDO.FILTER_ESTIMATED_EFFORT and Artifact2SoapDO.FILTER_AUTOSUMMING.
• New column constants Artifact2SoapDO.COLUMN_PLANNING_FOLDER_ID, Artifact2SoapDO.COLUMN_PLANNING_FOLDER_TITLE, Artifact2SoapDO.COLUMN_ESTIMATED_EFFORT, Artifact2SoapDO.COLUMN_REMAINING_EFFORT, Artifact2SoapDO.COLUMN_ACTUAL_EFFORT and Artifact2SoapDO.COLUMN_AUTOSUMMING

Version 4.4 SP 1

• getAllowedWorkflowTransitionList: Added the missing [new artifact] transitions to the list

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 incorporated into setArtifactData
• setField: New exception added in 4.4: DependencyViolationFault
• getArtifactList: Added a limit to the number of rows that could be retrieved. 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, java.lang.String helpText) 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, java.lang.String helpText) Adds a custom multi select field to a tracker.
void	addSeparator(java.lang.String sessionId, java.lang.String trackerId, java.lang.String separatorType, java.lang.String separatorLabel) Adds a separator to a tracker.
void	addSingleSelectChildField(java.lang.String sessionId, java.lang.String trackerId, java.lang.String fieldName, java.lang.String[] fieldValues, java.lang.String parentFieldId, SoapNamedValues parentChildFieldValueMap, java.lang.String helpText) Adds a custom single 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, java.lang.String helpText) 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, java.lang.String helpText, java.lang.String pattern) 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, java.lang.String helpText) Adds a custom User selection field to a tracker.
void	copyWorkflowTransitions(java.lang.String sessionId, java.lang.String srcTrackerId, java.lang.String dstTrackerId) Copies 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 estimatedEffort, int remainingEffort, boolean autosumming, int points, java.lang.String assignedUsername, java.lang.String releaseId, java.lang.String planningFolderId, 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) Creates 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, java.lang.String icon) Creates a new tracker with an icon
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) Deletes a custom/flex-field .
void	deleteSeparator(java.lang.String sessionId, java.lang.String trackerId, java.lang.String layoutId) Deletes a separator of a tracker layout.
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) Gets 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, 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) Gets the dependency list for an artifact where the artifact is the origin artifact.
ArtifactDetailSoapList	getCrossTrackerArtifactList(java.lang.String sessionId, java.lang.String containerId, SoapFilter[] filters, java.lang.String[] selectedColumns) Returns a filtered list of artifacts within the specified container (project or tracker).
TrackerFieldSoapDO[]	getFields(java.lang.String sessionId, java.lang.String trackerId) Returns the custom/flex-fields associated with a specific tracker.
OrderedTrackerFieldSoapList	getOrderedTrackerFields(java.lang.String sessionId, java.lang.String trackerId) Returns all fields and separators in the given tracker with layout information.
ArtifactDependencySoapList	getParentDependencyList(java.lang.String sessionId, java.lang.String artifactId) Gets 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 in the order that they are displayed in the UI.
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) Removes an artifact dependency between two artifacts.
void	reorderTrackerFields(java.lang.String sessionId, java.lang.String trackerId, java.lang.String[] layoutIds) Sets a new order of the fields and the separators within a tracker.
void	reorderTrackers(java.lang.String sessionId, java.lang.String[] trackerIds) Sets a new order of the trackers within a project.
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	setArtifactRank(java.lang.String sessionId, java.lang.String planningFolderId, java.lang.String artfToRankId, java.lang.String artfBeforeId, java.lang.String artfAfterId) Sets the rank of an artifact relative to one or more other artifacts, in the context of a specific planning folder.
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 in the order that they are displayed in the UI.

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

List of trackers within the project.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid or field or icon could not be found.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when invalid data is specified.

com.collabnet.ce.soap60.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,
                            java.lang.String icon)
                            throws java.rmi.RemoteException

Creates a new tracker with an icon

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

icon - The tracker icon (null or something between "icon_01.png" and "icon_99.png")

Returns:

the tracker soap object

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid or icon could not be found.

com.collabnet.ce.soap60.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). This method was introduced to be able to set properties of the help text in TeamForge 5.4.1

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.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.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 - INVALID_FIELD_PATTERN

com.collabnet.ce.soap60.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.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.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,
                  java.lang.String helpText,
                  java.lang.String pattern)
                  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

helpText - The help text for the field

pattern - The field validation pattern

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

addSingleSelectChildField

void addSingleSelectChildField(java.lang.String sessionId,
                               java.lang.String trackerId,
                               java.lang.String fieldName,
                               java.lang.String[] fieldValues,
                               java.lang.String parentFieldId,
                               SoapNamedValues parentChildFieldValueMap,
                               java.lang.String helpText)
                               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

fieldValues - Array of valid field values

parentFieldId - The id of the parent field

parentChildFieldValueMap - soapNamedValues which keeps mapping between parent field values and child values

helpText - the help text for the field

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.4.1

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,
                          java.lang.String helpText)
                          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

helpText - the help text for the field

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.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,
                         java.lang.String helpText)
                         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

helpText - the help text for the field

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.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,
                        java.lang.String helpText)
                        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

helpText - The help text of the field

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.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,
                  java.lang.String helpText)
                  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

helpText - the help text of the field

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - if the object has been updated since this fieldDO was fetched

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.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

Deletes a custom/flex-field .

Parameters:

sessionId - User session id.

objectId - Object (e.g. tracker).

fieldId - the id of the field to delete

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id or fieldData is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed.

com.collabnet.ce.soap60.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. This method has been introduced to also return the properties of the planning folder, the actual, estimated and remaining effort fields as well as the autosumming flag.

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all field values.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

addSeparator

void addSeparator(java.lang.String sessionId,
                  java.lang.String trackerId,
                  java.lang.String separatorType,
                  java.lang.String separatorLabel)
                  throws java.rmi.RemoteException

Adds a separator to a tracker. The separator will be added at the end of tracker fields. To reorder separator and fields, use getOrderedTrackerFields and reorderTrackerFields.

Parameters:

sessionId - User session id.

trackerId - The tracker to add the separator to.

separatorType - the type of the separator, either OrderedTrackerFieldSoapRow.ROW_SEPARATOR OrderedTrackerFieldSoapRow.COLUMN_SEPARATOR or OrderedTrackerFieldSoapRow.SECTION_SEPARATOR.

separatorLabel - the label of the separator

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - if a separator with the same id exists

java.rmi.RemoteException

Since:

5.4.1

deleteSeparator

void deleteSeparator(java.lang.String sessionId,
                     java.lang.String trackerId,
                     java.lang.String layoutId)
                     throws java.rmi.RemoteException

Deletes a separator of a tracker layout.

Parameters:

sessionId - User session id.

trackerId - The tracker to delete the separator from.

layoutId - the layout id of the separator. To get the layout id, use getOrderedTrackerFields.

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the arguments are incorrectly specified

com.collabnet.ce.soap60.fault.InvalidOperationFault - if the operation is not allowed

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.4.1

getOrderedTrackerFields

OrderedTrackerFieldSoapList getOrderedTrackerFields(java.lang.String sessionId,
                                                    java.lang.String trackerId)
                                                    throws java.rmi.RemoteException

Returns all fields and separators in the given tracker with layout information.

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all fields and separators.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.4.1

reorderTrackerFields

void reorderTrackerFields(java.lang.String sessionId,
                          java.lang.String trackerId,
                          java.lang.String[] layoutIds)
                          throws java.rmi.RemoteException

Sets a new order of the fields and the separators within a tracker. The fields and separators will be listed in this new order in UI and in the methods that list the fields and separators in the SOAP calls.

Parameters:

sessionId - User session id.

trackerId - Id of tracker which all the fields and the separators belong to.

layoutIds - An array of layout ids which can be obtained by getOrderedTrackerFields(). Layout id is different from field id and some system fields and separators do not have field id but only layout id.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - When any of the specified object id is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - If invalid argument value is passed.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - When an unexpected system level error occurs.

java.rmi.RemoteException

Since:

5.4.1

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 retrieved. This limit is by default 5000 but is configurable
• it is substantially obsolete 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when the specified filters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.1

getCrossTrackerArtifactList

ArtifactDetailSoapList getCrossTrackerArtifactList(java.lang.String sessionId,
                                                   java.lang.String containerId,
                                                   SoapFilter[] filters,
                                                   java.lang.String[] selectedColumns)
                                                   throws java.rmi.RemoteException

Returns a filtered list of artifacts within the specified container (project or tracker). Since this is a cross tracker query, flex fields may not be populated.

Parameters:

sessionId - User session id.

containerId - ID of a project or a tracker. (should not be null)

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

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

Returns:

List of filtered artifacts.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when the specified filters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

5.3

getArtifactDetailList

ArtifactDetailSoapList getArtifactDetailList(java.lang.String sessionId,
                                             java.lang.String trackerId,
                                             java.lang.String[] selectedColumns,
                                             SoapFilter[] filters,
                                             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. Unlike the corresponding method in earlier versions of the soap interface (soap44, etc.), this method now returns data for all flex fields, whether they have values or not. Flex fields with no values will have NULL values in the values[] array

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. Valid date formats are SoapFilter.DATE_FORMAT and SoapFilter.DATE_ONLY_FORMAT.

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.InvalidFilterFault - when the specified filters are invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.3-HOTFIX1

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.

com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the specified query string is invalid.

com.collabnet.ce.soap60.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. Unlike the corresponding method in earlier versions of the soap interface (soap44, etc.), this method now returns data for all flex fields, whether they have values or not. Flex fields with no values will have NULL values in the values[] array

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

the data associated with the artifact at the given path

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.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.

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.VersionMismatchFault - when the object data is stale.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the artifact data is invalid.

com.collabnet.ce.soap60.fault.InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when workflow rule is violated

com.collabnet.ce.soap60.fault.DependencyViolationFault - when dependency rule is violated

com.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault - when planning folder 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 estimatedEffort,
                              int remainingEffort,
                              boolean autosumming,
                              int points,
                              java.lang.String assignedUsername,
                              java.lang.String releaseId,
                              java.lang.String planningFolderId,
                              SoapFieldValues flexFields,
                              java.lang.String attachmentFileName,
                              java.lang.String attachmentMimeType,
                              java.lang.String attachmentFileId)
                              throws java.rmi.RemoteException

Creates a new artifact.

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.

estimatedEffort - Estimated effort to close artifact.

remainingEffort - Remaining effort to close artifact.

autosumming - Determines whether autosumming should be enabled for the newly created artifact.

points - The story points for this artifact.

assignedUsername - User this artifact should be assigned to.

releaseId - Release this artifact is assigned with.

planningFolderId - planning folder, this artifact belongs to

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the artifact data is invalid.

com.collabnet.ce.soap60.fault.InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

java.rmi.RemoteException

Since:

4.2

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permission is denied for the specified operation.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object is invalid.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when an invalid argument is passed in.

com.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault - when planning folder rule is violated

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.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

Gets workflow transitions for the tracker.

Change History

Version 4.4 SP 1

• Added the missing [new artifact] transitions to the list
• The returning list now will contain [new artifact] transition list with the following format [from value] [to value] null open null close null pending

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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.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

Copies 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.collabnet.ce.soap60.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

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

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

desc - Description for the dependency.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.collabnet.ce.soap60.fault.DependencyViolationFault - when the creation of the dependency causes violation

com.collabnet.ce.soap60.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

Removes an artifact dependency between two artifacts.

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.collabnet.ce.soap60.fault.DependencyViolationFault - when the creation of the dependency causes violation

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.

com.collabnet.ce.soap60.fault.NoSuchRelationshipFault - when ...

java.rmi.RemoteException

Since:

4.4

setArtifactRank

void setArtifactRank(java.lang.String sessionId,
                     java.lang.String planningFolderId,
                     java.lang.String artfToRankId,
                     java.lang.String artfBeforeId,
                     java.lang.String artfAfterId)
                     throws java.rmi.RemoteException

Sets the rank of an artifact relative to one or more other artifacts, in the context of a specific planning folder. If two artifacts are specified for artfBeforeId and artfAfterId, then the moved artifact is placed between them. If only artfBeforeId is specified, the moved artifact is placed after it; if only artfAfterId, the moved artifact is moved before it.

The ranking will be invalid if it doesn't respect certain rules:

- artifacts cannot be ranked relative to other artifacts unless at least one of the following is true:

1. they are children of the same parent
2. they appear at the top level in the planning folder view, i.e. do not have a parent in the specified planning folder.

- all specified artifacts must belong to the same project as the specified planning folder.

As of TeamForge 5.4, this operation requires the Planning Folder Admin permission; edit permission on the trackers involved is not sufficient. In the future, a distinct role permission for rank operations may be defined.

Parameters:

sessionId - User session id.

planningFolderId - the id of the planning folder in which we are doing the rank

artfToRankId - the artifact to rank

artfBeforeId - the artifact that should be before it

artfAfterId - the artifact that should be after it

Throws:

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when one of the specified object id is invalid.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the specified id is invalid.

com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.

com.collabnet.ce.soap60.fault.InvalidRankFault - when the requested rank operation is invalid

java.rmi.RemoteException

Since:

5.4

getChildDependencyList

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

Gets 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.collabnet.ce.soap60.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

Gets the dependency list for an artifact where the artifact is the target artifact. While in 5.3, 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.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.

com.collabnet.ce.soap60.fault.WorkflowViolationFault - when the copy of workflow transition cannot be completed

com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.

java.rmi.RemoteException

Since:

4.4

reorderTrackers

void reorderTrackers(java.lang.String sessionId,
                     java.lang.String[] trackerIds)
                     throws java.rmi.RemoteException

Sets a new order of the trackers within a project. The trackers will be listed in this new order in UI and in the methods that list the trackers in the SOAP calls.

Parameters:

sessionId - User session id.

trackerIds - An array of the tracker ids in their new order. All the tracker ids must belong to the same project

Throws:

com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.

com.collabnet.ce.soap60.fault.NoSuchObjectFault - When any of the specified object id is invalid.

com.collabnet.ce.soap60.fault.PermissionDeniedFault - When the user has insufficient privileges.

com.collabnet.ce.soap60.fault.SystemFault - When an unexpected system level error occurs.

com.collabnet.ce.soap60.fault.IllegalArgumentFault - If invalid argument value is passed.

java.rmi.RemoteException

Since:

5.4