java.lang.Object
- com.collabnet.ce.soap60.webservices.WebService
- - com.collabnet.ce.soap60.webservices.tracker.TrackerAppSoap

All Implemented Interfaces:

ITrackerAppSoap
```
public class TrackerAppSoap
extends WebService
implements ITrackerAppSoap
```
Provides SOAP services for managing user trackers and artifacts.

Change History

Version 18.1
- Modified to ignore the time portion of the custom Date field's value.
Version 17.11
- getAllowedWorkflowTransitionList3 New method to retrieve workflow transition list with auto populate fields
Version 17.8
- getAllowedWorkflowTransitionList2 New method to retrieve workflow transition list with hidden fields
Version 17.4
- getArtifactData3 New method to retrieve artifact with tags
- setArtifactData4 New method to support editing artifact with tags
- createArtifact4 New method to support creating artifact with tags
Version 16.7
- getFields2 New method, to get the filtered field roles in the 'assignedTo' field of tracker field
- setField2 New method, to set the filtered field roles into the tracker field
Version 8.0
- copyWorkflowTransitions Updated this method to copy workflow transitions between two trackers including global roles
- getArtifactList2 New method, to retrieve list of artifacts with autoSummingPoints and Team field Information
- setArtifactData3 New method, to support set Artifact Data with autoSummingPoints and Team field
- createArtifact3 New method, to support create Artifact with autoSummingPoints and Team field
- getArtifactData2 New method, to retrieve artifact with autoSummingPoints and Team field Information
Version 6.2

setArtifactData2 New method, to support set Artifact Data with multiple attachments, added in 6.2

createArtifact2 New method, to support create Artifact with multiple attachments, added in 6.2

getUnitsByProject New method, to retrieve the units for a given project, added in 6.2

createTracker2 New method, to create a tracker with the tracker unit, added in 6.2

getTracker2Data New method, to retrieve a tracker with the tracker unit, added in 6.2

setTracker2Data New method, to update a tracker with the tracker unit, added in 6.2

getTracker2List New method, to retrieve a tracker list with the tracker unit, added in 6.2

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

Field Summary

Fields
Modifier and Type Field Description

static String UNKNOWN_RELEASE
The unknown file release

static String WORKFLOW_FIELD_NAME_ACTUAL_EFFORT

static String WORKFLOW_FIELD_NAME_ACTUAL_HOURS
The field name that is used in workflow to specify "Actual Hours" as a required field

static String WORKFLOW_FIELD_NAME_ASSIGNEDTO
The field name that is used in workflow to specify "Assigned To" as a required field

static String WORKFLOW_FIELD_NAME_ATTACHMENT
The field name that is used in workflow to specify "Attachment" as a required field

static String WORKFLOW_FIELD_NAME_COMMENT
The field name that is used in workflow to specify "Comment" as a required field

static String WORKFLOW_FIELD_NAME_ESTIMATED_EFFORT

static String WORKFLOW_FIELD_NAME_ESTIMATED_HOURS
The field name that is used in workflow to specify "Estimated Hours" as a required field

static String WORKFLOW_FIELD_NAME_REMAINING_EFFORT

static String WORKFLOW_FIELD_NAME_REPORTED_IN_RELEASE
The field name that is used in workflow to specify "Reported In Release" as a required field

static String WORKFLOW_FIELD_NAME_RESOLVED_IN_RELEASE
The field name that is used in workflow to specify "Resolved In Release" as a required field

static String WORKFLOW_STATUS_VALUE_ANY
The field value workflow uses to represent a status transition to any value

static String WORKFLOW_STATUS_VALUE_NEW_ARTIFACT
The field value workflow uses to represent a status transition for a new artifact

Constructor Summary

Constructors
Constructor Description

TrackerAppSoap()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type Method Description

void addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText)
Adds a custom Date field to a tracker.

void addMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText)
Adds a custom multi select field to a tracker.

void addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel)
Adds a separator to a tracker.

void addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText)
Adds a custom single select field to a tracker.

void addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText)
Adds a custom single select field to a tracker.

void addTextField(String sessionId, String trackerId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern)
Adds a custom text field to a tracker.

void addUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText)
Adds a custom User selection field to a tracker.

Tracker2SoapDO cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription)
Clone Tracker within the same project

Tracker2SoapDO cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription)
Clone Tracker across the project

void copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId)
Copies workflow transitions between two trackers.

ArtifactSoapDO createArtifact(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId)
Deprecated.
in favor of createArtifact4

ArtifactSoapDO createArtifact2(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments)
Deprecated.
in favor of createArtifact4

Artifact2SoapDO createArtifact3(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments)
Deprecated.
in favor of createArtifact4

Artifact3SoapDO createArtifact4(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments, String[] tagNames)
Creates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.

void createArtifactDependency(String sessionId, String originId, String targetId, String desc)
Creates an artifact dependency between two artifacts.

TrackerSoapDO createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon)
Deprecated.
use createTracker3 instead, which includes tracker unit and autosum foreign children support

Tracker2SoapDO createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId)
Deprecated.
use createTracker3 instead, which includes foreign children support

Tracker3SoapDO createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren)
Creates a new tracker with autosum foreign children support

void deleteArtifact(String sessionId, String artifactId)
Deletes an artifact.

void deleteField(String sessionId, String objectId, String fieldId)
Deletes a custom/flex-field .

void deleteSeparator(String sessionId, String trackerId, String layoutId)
Deletes a separator of a tracker layout.

ArtifactSoapList findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments)
Deprecated.
in favor of findArtifacts2

Artifact2SoapList findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments)
Finds a list of artifacts matching a search string.

WorkflowTransitionSoapList getAllowedWorkflowTransitionList(String sessionId, String trackerId)
Deprecated.
in favor of getAllowedWorkflowTransitionList2

WorkflowTransition2SoapList getAllowedWorkflowTransitionList2(String sessionId, String trackerId)
Deprecated.
in favor of getAllowedWorkflowTransitionList3

WorkflowTransition3SoapList getAllowedWorkflowTransitionList3(String sessionId, String trackerId)
Gets workflow transitions for the tracker.

ArtifactSoapDO getArtifactData(String sessionId, String artifactId)
Deprecated.
in favor of getArtifactData3

Artifact2SoapDO getArtifactData2(String sessionId, String artifactId)
Deprecated.
in favor of getArtifactData3

Artifact3SoapDO getArtifactData3(String sessionId, String artifactId)
Returns data associated with the specified artifact.

ArtifactDetailSoapList getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery)
Deprecated.
in favor of getArtifactDetailList2

ArtifactDetail2SoapList getArtifactDetailList2(String sessionId, String trackerId, 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(String sessionId, String containerId, SoapFilter[] filters)
Deprecated.
in fovor of getArtifactList2

Artifact2SoapList getArtifactList2(String sessionId, String containerId, SoapFilter[] filters)
Returns a filtered list of artifacts within the specified container (project or tracker).

ArtifactDependencySoapList getChildDependencyList(String sessionId, String artifactId)
Gets the dependency list for an artifact where the artifact is the origin artifact.

ArtifactDetailSoapList getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns)
Deprecated.
in favor of getCrossTrackerArtifactList2

ArtifactDetail2SoapList getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns)
Returns a filtered list of artifacts within the specified container (project or tracker).

TrackerFieldSoapDO[] getFields(String sessionId, String trackerId)
Deprecated.
use getFields2 instead

TrackerField2SoapDO[] getFields2(String sessionId, String trackerId)
Returns the custom/flex-fields associated with a specific tracker.

OrderedTrackerFieldSoapList getOrderedTrackerFields(String sessionId, String trackerId)
Returns all fields and separators in the given tracker with layout information.

ArtifactDependencySoapList getParentDependencyList(String sessionId, String artifactId)
Gets the dependency list for an artifact where the artifact is the target artifact.

Tracker2SoapDO getTracker2Data(String sessionId, String trackerId)
Deprecated.
use getTracker3Data instead, which includes autosum foreign children support

Tracker2SoapList getTracker2List(String sessionId, String projectId)
Deprecated.
use getTracker3List instead, which includes autosum foreign children support

Tracker3SoapDO getTracker3Data(String sessionId, String trackerId)
Returns a data object for a given tracker

Tracker3SoapList getTracker3List(String sessionId, String projectId)
Returns a list of trackers for a project in the order that they are displayed in the UI.

TrackerSoapDO getTrackerData(String sessionId, String trackerId)
Deprecated.
use getTracker3Data instead, which includes tracker unit and autosum foreign children support

TrackerSoapList getTrackerList(String sessionId, String projectId)
Deprecated.
use getTracker3List instead, which includes tracker unit and autosum foreign children support

TrackerUnitSoapList getUnitsByProject(String sessionId, String projectId)
Gets the units for a given project.

ArtifactSoapDO moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee)
Deprecated.
in favor of moveArtifact2

Artifact2SoapDO moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee)
Moves an artifact to a specified target folder.

void removeArtifactDependency(String sessionId, String originId, String targetId)
Removes an artifact dependency between two artifacts.

void reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds)
Sets a new order of the fields and the separators within a tracker.

void reorderTrackers(String sessionId, String[] trackerIds)
Sets a new order of the trackers within a project.

void setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId)
Deprecated.
in favor of setArtifactData4

void setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments)
Deprecated.
in favor of setArtifactData4

void setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments)
Deprecated.
in favor of setArtifactData4

void setArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments)
Sets data associated along with multiple attachments with the specified artifact.

void setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, 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(String sessionId, String objectId, TrackerFieldSoapDO fieldData)
Deprecated.
use setField2 instead

void setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData)
Sets a custom/flex-field that is associated with a specific folder (e.g.

void setTracker2Data(String sessionId, Tracker2SoapDO trackerData)
Deprecated.
use setTracker3Data instead, which includes autosum foreign children support

void setTracker3Data(String sessionId, Tracker3SoapDO trackerData)
Sets data on a specific tracker with autosum foreign children support

void setTrackerData(String sessionId, TrackerSoapDO trackerData)
Deprecated.
use setTracker3Data instead, which includes tracker unit and autosum foreign children support

Methods inherited from class com.collabnet.ce.soap60.webservices.WebService
assertNormalProject, assertProjectGroup, canGiveFullUserDetails, checkGeneralPermission, checkPermission, checkPermission, checkSiteWidePermission, createUserSessionKey, downloadFile, filterInvalidProjMembers, generateFolderName, getAccessControlService, getApplicationRegistryService, getAttachment, getAuthenticationService, getCategorization, getCoreService, getDiscussion, getDocMan, getDocumentRootFolder, getFileStorageService, getFolderKey, getFolderPath, getFolderPath, getFolderPath, getFrs, getIntegrationData, getItemPath, getItemPath, getLocale, getMonitoring, getNews, getNulledMinSoapDate, getObjectKey, getObjectPath, getOperation, getPages, getPlanning, getPluggableComponent, getProjectId, getProjectPath, getProjectPath, getRbac, getSearch, getStoredFileSize, getStoredFileText, getTagService, getTeam, getTemplate, getTracker, getUser, getUserData, getUsername, getUserService, getWiki, hasPermission, hasSiteWidePermission, isFolderResource, isProjectGroup, isProjectId, isStrEmpty, isSuperUser, isValidEmail, makeStoredFileDO, makeStoredFileDOs, requireProjectAdminPermission, setPartialOrFullUserData, setUserNameToResponse, storeFile, storeTextFile, validateChoice, validateChoice, validateIconFile, validateString, validateStringArray, validateStringWithTrim, validateTokenAndExactUsername, validateTokenAndExactUsername, validateWikiPageName, verifyLicense

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WORKFLOW_FIELD_NAME_COMMENT

public static final String WORKFLOW_FIELD_NAME_COMMENT

The field name that is used in workflow to specify "Comment" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ATTACHMENT

public static final String WORKFLOW_FIELD_NAME_ATTACHMENT

The field name that is used in workflow to specify "Attachment" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ASSIGNEDTO

public static final String WORKFLOW_FIELD_NAME_ASSIGNEDTO

The field name that is used in workflow to specify "Assigned To" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ESTIMATED_HOURS

public static final String WORKFLOW_FIELD_NAME_ESTIMATED_HOURS

The field name that is used in workflow to specify "Estimated Hours" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ACTUAL_HOURS

public static final String WORKFLOW_FIELD_NAME_ACTUAL_HOURS

The field name that is used in workflow to specify "Actual Hours" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_REPORTED_IN_RELEASE

public static final String WORKFLOW_FIELD_NAME_REPORTED_IN_RELEASE

The field name that is used in workflow to specify "Reported In Release" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_RESOLVED_IN_RELEASE

public static final String WORKFLOW_FIELD_NAME_RESOLVED_IN_RELEASE

The field name that is used in workflow to specify "Resolved In Release" as a required field

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ESTIMATED_EFFORT

public static final String WORKFLOW_FIELD_NAME_ESTIMATED_EFFORT

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_ACTUAL_EFFORT

public static final String WORKFLOW_FIELD_NAME_ACTUAL_EFFORT

See Also:

Constant Field Values

WORKFLOW_FIELD_NAME_REMAINING_EFFORT

public static final String WORKFLOW_FIELD_NAME_REMAINING_EFFORT

See Also:

Constant Field Values

WORKFLOW_STATUS_VALUE_ANY

public static final String WORKFLOW_STATUS_VALUE_ANY

The field value workflow uses to represent a status transition to any value

See Also:

Constant Field Values

WORKFLOW_STATUS_VALUE_NEW_ARTIFACT

public static final String WORKFLOW_STATUS_VALUE_NEW_ARTIFACT

The field value workflow uses to represent a status transition for a new artifact

See Also:

Constant Field Values

UNKNOWN_RELEASE

public static final String UNKNOWN_RELEASE

The unknown file release

See Also:

Constant Field Values

Constructor Detail

TrackerAppSoap

public TrackerAppSoap()

Method Detail

getTrackerList

public TrackerSoapList getTrackerList(String sessionId, String projectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
use getTracker3List instead, which includes tracker unit and autosum foreign children support

Returns a list of trackers for a project in the order that they are displayed in the UI.

Specified by:

getTrackerList in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

List of trackers within the project.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

4.1

getTracker2List

public Tracker2SoapList getTracker2List(String sessionId, String projectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
use getTracker3List instead, which includes autosum foreign children support

Returns a list of trackers for a project in the order that they are displayed in the UI.

Specified by:

getTracker2List in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

List of trackers within the project.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

6.2

getTracker3List

public Tracker3SoapList getTracker3List(String sessionId, String projectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Returns a list of trackers for a project in the order that they are displayed in the UI.

Specified by:

getTracker3List in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

projectId - Project id.

Returns:

List of trackers within the project.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

8.0

getTrackerData

public TrackerSoapDO getTrackerData(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
use getTracker3Data instead, which includes tracker unit and autosum foreign children support

Returns a data object for a given tracker

Specified by:

getTrackerData in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

Detailed data on the tracker.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

"4.2"

getTracker2Data

public Tracker2SoapDO getTracker2Data(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
use getTracker3Data instead, which includes autosum foreign children support

Returns a data object for a given tracker

Specified by:

getTracker2Data in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

Detailed data on the tracker.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

"6.2"

getTracker3Data

public Tracker3SoapDO getTracker3Data(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Returns a data object for a given tracker

Specified by:

getTracker3Data in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

Detailed data on the tracker.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

8.0

setTrackerData

public void setTrackerData(String sessionId, TrackerSoapDO trackerData) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, VersionMismatchFault

Deprecated.
use setTracker3Data instead, which includes tracker unit and autosum foreign children support

Sets data on a specific tracker, using this method and not setTracker2Data will reset the tracker unit to the default

Specified by:

setTrackerData in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerData - Detailed data on the tracker to set.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid or field or icon could not be found.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when invalid data is specified.

VersionMismatchFault - when the object version mismatches the application server.

Since:

4.2

setTracker2Data

public void setTracker2Data(String sessionId, Tracker2SoapDO trackerData) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, VersionMismatchFault

Deprecated.
use setTracker3Data instead, which includes autosum foreign children support

Sets data on a specific tracker

Specified by:

setTracker2Data in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerData - Detailed data on the tracker to set.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid or field or icon could not be found.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when invalid data is specified.

VersionMismatchFault - when the object version mismatches the application server.

Since:

6.2

setTracker3Data

public void setTracker3Data(String sessionId, Tracker3SoapDO trackerData) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, VersionMismatchFault

Sets data on a specific tracker with autosum foreign children support

Specified by:

setTracker3Data in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerData - Detailed data on the tracker to set.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid or field or icon could not be found.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when invalid data is specified.

VersionMismatchFault - when the object version mismatches the application server.

Since:

8.0

createTracker

public TrackerSoapDO createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) throws InvalidSessionFault, PermissionDeniedFault, SystemFault, NoSuchObjectFault, ObjectAlreadyExistsFault

Deprecated.
use createTracker3 instead, which includes tracker unit and autosum foreign children support

Creates a new tracker with an icon

Specified by:

createTracker in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

NoSuchObjectFault - when the specified object id is invalid or icon could not be found.

ObjectAlreadyExistsFault - if an existing tracker already exists

Since:

4.3-HOTFIX1

createTracker2

public Tracker2SoapDO createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) throws InvalidSessionFault, PermissionDeniedFault, SystemFault, NoSuchObjectFault, ObjectAlreadyExistsFault

Deprecated.
use createTracker3 instead, which includes foreign children support

Creates a new tracker with an icon

Specified by:

createTracker2 in interface ITrackerAppSoap

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")

trackerUnitId - The tracker unit

Returns:

the tracker soap object

Throws:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

NoSuchObjectFault - when the specified object id is invalid or icon could not be found.

ObjectAlreadyExistsFault - if an existing tracker already exists

Since:

6.2

createTracker3

public Tracker3SoapDO createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) throws InvalidSessionFault, PermissionDeniedFault, SystemFault, NoSuchObjectFault, ObjectAlreadyExistsFault, IllegalArgumentFault

Creates a new tracker with autosum foreign children support

Specified by:

createTracker3 in interface ITrackerAppSoap

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")

trackerUnitId - The tracker unit

autosumForeignChildren - The flag indicating whether the autosum calculation of effort and points includes children from foreign projects

Returns:

the tracker soap object

Throws:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

NoSuchObjectFault - when the specified object id is invalid or icon could not be found.

ObjectAlreadyExistsFault - if an existing tracker already exists

IllegalArgumentFault - if the arguments are incorrectly specified

Since:

8.0

setField

public void setField(String sessionId, String objectId, TrackerFieldSoapDO fieldData) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault, DependencyViolationFault

Deprecated.
use setField2 instead

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

Specified by:

setField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

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

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

SystemFault - when an unexpected system error occurs.

DependencyViolationFault - if changing a status violates artifact dependency

Since:

4.3-HOTFIX1

See Also:

FaultSummary

setField2

public void setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault, DependencyViolationFault

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 tracker field and also supporting to set the field role filters for the 'assignedTo' field

Specified by:

setField2 in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

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

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

SystemFault - when an unexpected system error occurs.

DependencyViolationFault - if changing a status violates artifact dependency

Since:

16.7

See Also:

FaultSummary

addTextField

public void addTextField(String sessionId, String trackerId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom text field to a tracker.

Specified by:

addTextField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

addSingleSelectChildField

public void addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom single select field to a tracker.

Specified by:

addSingleSelectChildField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

5.4.1

addSingleSelectField

public void addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom single select field to a tracker.

Specified by:

addSingleSelectField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

addMultiSelectField

public void addMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom multi select field to a tracker.

Specified by:

addMultiSelectField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

addUserSelectField

public void addUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom User selection field to a tracker.

Specified by:

addUserSelectField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

4.3-SP1

See Also:

TrackerFieldSoapDO.FIELD_USER_FILTER_PROJECT_MEMBER, TrackerFieldSoapDO.FIELD_USER_FILTER_ALL

addDateField

public void addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Adds a custom Date field to a tracker.

Specified by:

addDateField in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - if the object has been updated since this fieldDO was fetched

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

4.3-SP1

deleteField

public void deleteField(String sessionId, String objectId, String fieldId) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, InvalidOperationFault, SystemFault

Deletes a custom/flex-field .

Specified by:

deleteField in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

objectId - Object (e.g. tracker).

fieldId - the id of the field to delete

Throws:

NoSuchObjectFault - when the specified object id or fieldData is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidOperationFault - if the operation is not allowed.

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

getFields

public TrackerFieldSoapDO[] getFields(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
use getFields2 instead

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.

Specified by:

getFields in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all field values.

Throws:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

getFields2

public TrackerField2SoapDO[] getFields2(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Returns the custom/flex-fields associated with a specific tracker. In addition to the features of getFields api, it returns the field role filters of the field(eg: 'assignedTo' field) in the Tracker

Specified by:

getFields2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all field values.

Throws:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when an unexpected system error occurs.

Since:

16.7

addSeparator

public void addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, IllegalArgumentFault, SystemFault, ObjectAlreadyExistsFault

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.

Specified by:

addSeparator in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

IllegalArgumentFault - if the arguments are incorrectly specified

SystemFault - when an unexpected system error occurs.

ObjectAlreadyExistsFault - if a separator with the same id exists

Since:

5.4.1

deleteSeparator

public void deleteSeparator(String sessionId, String trackerId, String layoutId) throws NoSuchObjectFault, InvalidSessionFault, PermissionDeniedFault, IllegalArgumentFault, InvalidOperationFault, SystemFault

Deletes a separator of a tracker layout.

Specified by:

deleteSeparator in interface ITrackerAppSoap

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:

NoSuchObjectFault - when the specified object id is invalid

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

IllegalArgumentFault - if the arguments are incorrectly specified

InvalidOperationFault - if the operation is not allowed

SystemFault - when an unexpected system error occurs.

Since:

5.4.1

getOrderedTrackerFields

public OrderedTrackerFieldSoapList getOrderedTrackerFields(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

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

Specified by:

getOrderedTrackerFields in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - The tracker for which to return field information.

Returns:

Array of all fields and separators.

Throws:

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when an unexpected system error occurs.

Since:

5.4.1

reorderTrackerFields

public void reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds) throws InvalidSessionFault, NoSuchObjectFault, IllegalArgumentFault, PermissionDeniedFault, SystemFault

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.

Specified by:

reorderTrackerFields in interface ITrackerAppSoap

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:

InvalidSessionFault - When the specified session id is invalid.

NoSuchObjectFault - When any of the specified object id is invalid.

IllegalArgumentFault - If invalid argument value is passed.

PermissionDeniedFault - When the user has insufficient privileges.

SystemFault - When an unexpected system level error occurs.

Since:

5.4.1

getArtifactList

public ArtifactSoapList getArtifactList(String sessionId, String containerId, SoapFilter[] filters) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

Deprecated.
in fovor of getArtifactList2

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.

Specified by:

getArtifactList in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

4.1

getArtifactList2

public Artifact2SoapList getArtifactList2(String sessionId, String containerId, SoapFilter[] filters) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

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

Specified by:

getArtifactList2 in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

8.0

getCrossTrackerArtifactList

public ArtifactDetailSoapList getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

Deprecated.
in favor of getCrossTrackerArtifactList2

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.

Specified by:

getCrossTrackerArtifactList in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

5.3

getCrossTrackerArtifactList2

public ArtifactDetail2SoapList getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

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.

Specified by:

getCrossTrackerArtifactList2 in interface ITrackerAppSoap

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 Artifact2SoapDO for column names constant values e.g. Artifact2SoapDO.COLUMN_CATEGORY.

Returns:

List of filtered artifacts.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

8.0

getArtifactDetailList

public ArtifactDetailSoapList getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

Deprecated.
in favor of getArtifactDetailList2

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.

Specified by:

getArtifactDetailList in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

4.3-HOTFIX1

getArtifactDetailList2

public ArtifactDetail2SoapList getArtifactDetailList2(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, InvalidFilterFault, SystemFault

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.COLUM ArtifactSoapDO.COLUMN_ASSIGNED_TO, FILTER_PRIORITY, FILTER, FILTER_CATEGORY, etc.

Specified by:

getArtifactDetailList2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.
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. Artifact2SoapDO .COLUMN_AUTO_SUMMING_POINTS

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

InvalidFilterFault - when the specified filters are invalid.

SystemFault - when an unexpected system error occurs.

Since:

8.0

findArtifacts

public ArtifactSoapList findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments) throws InvalidSessionFault, NoSuchObjectFault, SearchQuerySyntaxFault, SystemFault, IllegalArgumentFault

Deprecated.
in favor of findArtifacts2

Finds a list of artifacts matching a search string.

Specified by:

findArtifacts in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified project id is invalid.

SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

IllegalArgumentFault - when the specified query string is invalid.

SystemFault - when an unexpected system level error occurs.

Since:

4.1

findArtifacts2

public Artifact2SoapList findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments) throws InvalidSessionFault, NoSuchObjectFault, SearchQuerySyntaxFault, SystemFault, IllegalArgumentFault

Finds a list of artifacts matching a search string.

Specified by:

findArtifacts2 in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified project id is invalid.

SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.

IllegalArgumentFault - when the specified query string is invalid.

SystemFault - when an unexpected system level error occurs.

Since:

8.0

getArtifactData

public ArtifactSoapDO getArtifactData(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
in favor of getArtifactData3

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

Specified by:

getArtifactData in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

the data associated with the artifact at the given path

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

4.1

getArtifactData2

public Artifact2SoapDO getArtifactData2(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deprecated.
in favor of getArtifactData3

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

Specified by:

getArtifactData2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

the data associated with the artifact at the given path

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

8.0

getArtifactData3

public Artifact3SoapDO getArtifactData3(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

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

Specified by:

getArtifactData3 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

the data associated with the artifact at the given path

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

Since:

17.4

setArtifactData

public void setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, SystemFault, WorkflowViolationFault, DependencyViolationFault, PlanningFolderRuleViolationFault, InconsistentFieldValueFault

Deprecated.
in favor of setArtifactData4

Sets data associated with the specified artifact.

Specified by:

setArtifactData in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - when the object data is stale.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid.

SystemFault - when an unexpected system error occurs.

WorkflowViolationFault - when workflow rule is violated

DependencyViolationFault - when dependency rule is violated

PlanningFolderRuleViolationFault - when planning folder rule is violated

Since:

4.1

setArtifactData2

public void setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, SystemFault, WorkflowViolationFault, DependencyViolationFault, PlanningFolderRuleViolationFault, InconsistentFieldValueFault

Deprecated.
in favor of setArtifactData4

Sets data associated along with multiple attachments with the specified artifact.

Specified by:

setArtifactData2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

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

comment - Comment associated with the change.

attachments - attached file List

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - when the object data is stale.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid.

SystemFault - when an unexpected system error occurs.

WorkflowViolationFault - when workflow rule is violated

DependencyViolationFault - when dependency rule is violated

PlanningFolderRuleViolationFault - when planning folder rule is violated

Since:

6.2

setArtifactData3

public void setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, SystemFault, WorkflowViolationFault, DependencyViolationFault, PlanningFolderRuleViolationFault, InconsistentFieldValueFault

Deprecated.
in favor of setArtifactData4

Sets data associated along with multiple attachments with the specified artifact.

Specified by:

setArtifactData3 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

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

comment - Comment associated with the change.

attachments - attached file List

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - when the object data is stale.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid.

SystemFault - when an unexpected system error occurs.

WorkflowViolationFault - when workflow rule is violated

DependencyViolationFault - when dependency rule is violated

PlanningFolderRuleViolationFault - when planning folder rule is violated

Since:

8.0

setArtifactData4

public void setArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, VersionMismatchFault, IllegalArgumentFault, SystemFault, WorkflowViolationFault, DependencyViolationFault, PlanningFolderRuleViolationFault, InconsistentFieldValueFault

Sets data associated along with multiple attachments with the specified artifact.

Specified by:

setArtifactData4 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

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

comment - Comment associated with the change.

attachments - attached file List

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

VersionMismatchFault - when the object data is stale.

IllegalArgumentFault - when the artifact data is invalid.

SystemFault - when an unexpected system error occurs.

WorkflowViolationFault - when workflow rule is violated

DependencyViolationFault - when dependency rule is violated

PlanningFolderRuleViolationFault - when planning folder rule is violated

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

Since:

17.4

createArtifact

public ArtifactSoapDO createArtifact(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, InconsistentFieldValueFault

Deprecated.
in favor of createArtifact4

Creates a new artifact.

Specified by:

createArtifact in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker 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.

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

SystemFault - when an unexpected system error occurs.

Since:

4.2

createArtifact2

public ArtifactSoapDO createArtifact2(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, InconsistentFieldValueFault

Deprecated.
in favor of createArtifact4

Creates a new artifact with multiple attachments.

Specified by:

createArtifact2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker 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.

attachments - attached file List (or null)

Returns:

Newly created artifact object.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

SystemFault - when an unexpected system error occurs.

Since:

6.2

createArtifact3

public Artifact2SoapDO createArtifact3(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, InconsistentFieldValueFault

Deprecated.
in favor of createArtifact4

Creates a new artifact with multiple attachments and flag to enable the autosumming_points.

Specified by:

createArtifact3 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker 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. This will be ignored if autosumming is set to true.

remainingEffort - Remaining effort to close artifact. This will be ignored if autosumming is set to true.

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

points - The story points for this artifact. This will be ignored if autoSummingPoints is set to true.

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

assignedUsername - User this artifact should be assigned to.

releaseId - Release this artifact is assigned with.

planningFolderId - planning folder, this artifact belongs to

teamId - team, this artifact belongs to

flexFields - Flex field values.

attachments - attached file List (or null)

Returns:

Newly created artifact object.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

SystemFault - when an unexpected system error occurs.

Since:

8.0

createArtifact4

public Artifact3SoapDO createArtifact4(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments, String[] tagNames) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault, InconsistentFieldValueFault

Creates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.

Specified by:

createArtifact4 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker 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. This will be ignored if autosumming is set to true.

remainingEffort - Remaining effort to close artifact. This will be ignored if autosumming is set to true.

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

points - The story points for this artifact. This will be ignored if autoSummingPoints is set to true.

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

assignedUsername - User this artifact should be assigned to.

releaseId - Release this artifact is assigned with.

planningFolderId - planning folder, this artifact belongs to

teamId - team, this artifact belongs to

flexFields - Flex field values.

attachments - attached file List (or null)

tagNames - tag names
Note:. Tags will be created, if they do not exist in the project.
Use TagAppSoap#listTags(String, String) to get the tags existing in a project.

Returns:

Newly created artifact object.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when the artifact data is invalid.

InconsistentFieldValueFault - when field hierarchy has been changed and the values are no longer valid

Since:

17.4

moveArtifact

public ArtifactSoapDO moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, SystemFault, IllegalArgumentFault, PlanningFolderRuleViolationFault

Deprecated.
in favor of moveArtifact2

Moves an artifact to a specified target folder.

Specified by:

moveArtifact in interface ITrackerAppSoap

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:

InvalidSessionFault - when the sessionId is invalid.

PermissionDeniedFault - when permission is denied for the specified operation.

NoSuchObjectFault - when the specified object is invalid.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when an invalid argument is passed in.

PlanningFolderRuleViolationFault - when planning folder rule is violated

Since:

4.2

moveArtifact2

public Artifact2SoapDO moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws InvalidSessionFault, PermissionDeniedFault, NoSuchObjectFault, SystemFault, IllegalArgumentFault, PlanningFolderRuleViolationFault

Moves an artifact to a specified target folder.

Specified by:

moveArtifact2 in interface ITrackerAppSoap

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:

InvalidSessionFault - when the sessionId is invalid.

PermissionDeniedFault - when permission is denied for the specified operation.

NoSuchObjectFault - when the specified object is invalid.

SystemFault - when an unexpected system error occurs.

IllegalArgumentFault - when an invalid argument is passed in.

PlanningFolderRuleViolationFault - when planning folder rule is violated

Since:

8.0

deleteArtifact

public void deleteArtifact(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault

Deletes an artifact.

Specified by:

deleteArtifact in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system level error occurs.

Since:

4.1

getAllowedWorkflowTransitionList

public WorkflowTransitionSoapList getAllowedWorkflowTransitionList(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault

Deprecated.
in favor of getAllowedWorkflowTransitionList2

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

Specified by:

getAllowedWorkflowTransitionList in interface ITrackerAppSoap

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:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when ...

Since:

4.3

getAllowedWorkflowTransitionList2

public WorkflowTransition2SoapList getAllowedWorkflowTransitionList2(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault

Deprecated.
in favor of getAllowedWorkflowTransitionList3

Gets workflow transitions for the tracker.

Change History

Version 17.8

Added 'hiddenFields' info to transition data

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

Specified by:

getAllowedWorkflowTransitionList2 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

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

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when ...

Since:

17.8

copyWorkflowTransitions

public void copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, SystemFault

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.

Specified by:

copyWorkflowTransitions in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

srcTrackerId - Tracker id.

dstTrackerId - Tracker id.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

WorkflowViolationFault - when the copy of workflow transition cannot be completed

SystemFault - when an unexpected system level error occurs.

Since:

4.3-SP1-HOTFIX3

cloneTracker

public Tracker2SoapDO cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, ObjectAlreadyExistsFault, SystemFault

Clone Tracker within the same project

Specified by:

cloneTracker in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

srcTrackerId - Tracker id.

destTrackerTitle - destination Tracker tile

destTrackerDescription - destination Tracker description

Returns:

returns cloned Tracker

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

ObjectAlreadyExistsFault - if an existing tracker already exists.

SystemFault - when an unexpected system level error occurs.

Since:

8.0

cloneTrackerAcrossProject

public Tracker2SoapDO cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, ObjectAlreadyExistsFault, SystemFault

Clone Tracker across the project

Specified by:

cloneTrackerAcrossProject in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

srcTrackerId - Tracker id.

destProjectId - on which project you need to create a tracker

destTrackerTitle - destination tracker title

destTrackerDescription - destination tracker description

Returns:

returns cloned tracker

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

ObjectAlreadyExistsFault - if an existing tracker already exists.

SystemFault - when an unexpected system level error occurs.

WorkflowViolationFault

Since:

8.0

createArtifactDependency

public void createArtifactDependency(String sessionId, String originId, String targetId, String desc) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, DependencyViolationFault, SystemFault

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

Specified by:

createArtifactDependency in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

desc - Description for the dependency.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

WorkflowViolationFault - when the copy of workflow transition cannot be completed

DependencyViolationFault - when the creation of the dependency causes violation

SystemFault - when an unexpected system level error occurs.

Since:

4.4

removeArtifactDependency

public void removeArtifactDependency(String sessionId, String originId, String targetId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, DependencyViolationFault, NoSuchRelationshipFault, SystemFault

Removes an artifact dependency between two artifacts.

Specified by:

removeArtifactDependency in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

originId - Origin artifact id.

targetId - Target artifact id.

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

WorkflowViolationFault - when the copy of workflow transition cannot be completed

DependencyViolationFault - when the creation of the dependency causes violation

SystemFault - when an unexpected system level error occurs.

NoSuchRelationshipFault - when ...

Since:

4.4

setArtifactRank

public void setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, String artfAfterId) throws NoSuchObjectFault, IllegalArgumentFault, InvalidSessionFault, PermissionDeniedFault, SystemFault, InvalidRankFault

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:

they are children of the same parent

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.

Specified by:

setArtifactRank in interface ITrackerAppSoap

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:

NoSuchObjectFault - when one of the specified object id is invalid.

IllegalArgumentFault - when the specified id is invalid.

InvalidSessionFault - when the specified session id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

SystemFault - when an unexpected system level error occurs.

InvalidRankFault - when the requested rank operation is invalid

Since:

5.4

getChildDependencyList

public ArtifactDependencySoapList getChildDependencyList(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, SystemFault

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

Specified by:

getChildDependencyList in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

dependency list

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

WorkflowViolationFault - when the copy of workflow transition cannot be completed

SystemFault - when an unexpected system level error occurs.

Since:

4.4

getParentDependencyList

public ArtifactDependencySoapList getParentDependencyList(String sessionId, String artifactId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, WorkflowViolationFault, SystemFault

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.

Specified by:

getParentDependencyList in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

artifactId - Artifact id.

Returns:

dependency list

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

PermissionDeniedFault - when the user has insufficient privileges.

WorkflowViolationFault - when the copy of workflow transition cannot be completed

SystemFault - when an unexpected system level error occurs.

Since:

4.4

reorderTrackers

public void reorderTrackers(String sessionId, String[] trackerIds) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault

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.

Specified by:

reorderTrackers in interface ITrackerAppSoap

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:

InvalidSessionFault - When the specified session id is invalid.

NoSuchObjectFault - When any of the specified object id is invalid.

PermissionDeniedFault - When the user has insufficient privileges.

SystemFault - When an unexpected system level error occurs.

IllegalArgumentFault - If invalid argument value is passed.

Since:

5.4

getUnitsByProject

public TrackerUnitSoapList getUnitsByProject(String sessionId, String projectId) throws InvalidSessionFault, NoSuchObjectFault, PermissionDeniedFault, SystemFault, IllegalArgumentFault

Gets the units for a given project.

Specified by:

getUnitsByProject in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

projectId - The id of the project to retrieve the units

Throws:

InvalidSessionFault - When the specified session id is invalid.

NoSuchObjectFault - When any of the specified object id is invalid.

PermissionDeniedFault - When the user has insufficient privileges.

SystemFault - When an unexpected system level error occurs.

IllegalArgumentFault - If invalid argument value is passed.

Since:

6.2

getAllowedWorkflowTransitionList3

public WorkflowTransition3SoapList getAllowedWorkflowTransitionList3(String sessionId, String trackerId) throws InvalidSessionFault, NoSuchObjectFault, SystemFault

Gets workflow transitions for the tracker.

Change History

Version 17.11

Added 'autoPopulateData' info to transition data

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

Specified by:

getAllowedWorkflowTransitionList3 in interface ITrackerAppSoap

Parameters:

sessionId - User session id.

trackerId - Tracker id.

Returns:

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

Throws:

InvalidSessionFault - when the specified session id is invalid.

NoSuchObjectFault - when the specified object id is invalid.

SystemFault - when ...

Since:

17.11

Modifier and Type	Field	Description
`static String`	`UNKNOWN_RELEASE`	The unknown file release
`static String`	`WORKFLOW_FIELD_NAME_ACTUAL_EFFORT`
`static String`	`WORKFLOW_FIELD_NAME_ACTUAL_HOURS`	The field name that is used in workflow to specify "Actual Hours" as a required field
`static String`	`WORKFLOW_FIELD_NAME_ASSIGNEDTO`	The field name that is used in workflow to specify "Assigned To" as a required field
`static String`	`WORKFLOW_FIELD_NAME_ATTACHMENT`	The field name that is used in workflow to specify "Attachment" as a required field
`static String`	`WORKFLOW_FIELD_NAME_COMMENT`	The field name that is used in workflow to specify "Comment" as a required field
`static String`	`WORKFLOW_FIELD_NAME_ESTIMATED_EFFORT`
`static String`	`WORKFLOW_FIELD_NAME_ESTIMATED_HOURS`	The field name that is used in workflow to specify "Estimated Hours" as a required field
`static String`	`WORKFLOW_FIELD_NAME_REMAINING_EFFORT`
`static String`	`WORKFLOW_FIELD_NAME_REPORTED_IN_RELEASE`	The field name that is used in workflow to specify "Reported In Release" as a required field
`static String`	`WORKFLOW_FIELD_NAME_RESOLVED_IN_RELEASE`	The field name that is used in workflow to specify "Resolved In Release" as a required field
`static String`	`WORKFLOW_STATUS_VALUE_ANY`	The field value workflow uses to represent a status transition to any value
`static String`	`WORKFLOW_STATUS_VALUE_NEW_ARTIFACT`	The field value workflow uses to represent a status transition for a new artifact

Modifier and Type	Method	Description
`void`	`addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText)`	Adds a custom Date field to a tracker.
`void`	`addMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText)`	Adds a custom multi select field to a tracker.
`void`	`addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel)`	Adds a separator to a tracker.
`void`	`addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText)`	Adds a custom single select field to a tracker.
`void`	`addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText)`	Adds a custom single select field to a tracker.
`void`	`addTextField(String sessionId, String trackerId, String fieldName, int displayColumns, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String defaultValue, String helpText, String pattern)`	Adds a custom text field to a tracker.
`void`	`addUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText)`	Adds a custom User selection field to a tracker.
`Tracker2SoapDO`	`cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription)`	Clone Tracker within the same project
`Tracker2SoapDO`	`cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription)`	Clone Tracker across the project
`void`	`copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId)`	Copies workflow transitions between two trackers.
`ArtifactSoapDO`	`createArtifact(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId)`	Deprecated. in favor of createArtifact4
`ArtifactSoapDO`	`createArtifact2(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, String assignedUsername, String releaseId, String planningFolderId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments)`	Deprecated. in favor of createArtifact4
`Artifact2SoapDO`	`createArtifact3(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments)`	Deprecated. in favor of createArtifact4
`Artifact3SoapDO`	`createArtifact4(String sessionId, String trackerId, String title, String description, String group, String category, String status, String customer, int priority, int estimatedEffort, int remainingEffort, boolean autosumming, int points, boolean autoSummingPoints, String assignedUsername, String releaseId, String planningFolderId, String teamId, SoapFieldValues flexFields, AttachmentSoapDO[] attachments, String[] tagNames)`	Creates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.
`void`	`createArtifactDependency(String sessionId, String originId, String targetId, String desc)`	Creates an artifact dependency between two artifacts.
`TrackerSoapDO`	`createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon)`	Deprecated. use createTracker3 instead, which includes tracker unit and autosum foreign children support
`Tracker2SoapDO`	`createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId)`	Deprecated. use createTracker3 instead, which includes foreign children support
`Tracker3SoapDO`	`createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren)`	Creates a new tracker with autosum foreign children support
`void`	`deleteArtifact(String sessionId, String artifactId)`	Deletes an artifact.
`void`	`deleteField(String sessionId, String objectId, String fieldId)`	Deletes a custom/flex-field .
`void`	`deleteSeparator(String sessionId, String trackerId, String layoutId)`	Deletes a separator of a tracker layout.
`ArtifactSoapList`	`findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments)`	Deprecated. in favor of findArtifacts2
`Artifact2SoapList`	`findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments)`	Finds a list of artifacts matching a search string.
`WorkflowTransitionSoapList`	`getAllowedWorkflowTransitionList(String sessionId, String trackerId)`	Deprecated. in favor of getAllowedWorkflowTransitionList2
`WorkflowTransition2SoapList`	`getAllowedWorkflowTransitionList2(String sessionId, String trackerId)`	Deprecated. in favor of getAllowedWorkflowTransitionList3
`WorkflowTransition3SoapList`	`getAllowedWorkflowTransitionList3(String sessionId, String trackerId)`	Gets workflow transitions for the tracker.
`ArtifactSoapDO`	`getArtifactData(String sessionId, String artifactId)`	Deprecated. in favor of getArtifactData3
`Artifact2SoapDO`	`getArtifactData2(String sessionId, String artifactId)`	Deprecated. in favor of getArtifactData3
`Artifact3SoapDO`	`getArtifactData3(String sessionId, String artifactId)`	Returns data associated with the specified artifact.
`ArtifactDetailSoapList`	`getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery)`	Deprecated. in favor of getArtifactDetailList2
`ArtifactDetail2SoapList`	`getArtifactDetailList2(String sessionId, String trackerId, 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(String sessionId, String containerId, SoapFilter[] filters)`	Deprecated. in fovor of getArtifactList2
`Artifact2SoapList`	`getArtifactList2(String sessionId, String containerId, SoapFilter[] filters)`	Returns a filtered list of artifacts within the specified container (project or tracker).
`ArtifactDependencySoapList`	`getChildDependencyList(String sessionId, String artifactId)`	Gets the dependency list for an artifact where the artifact is the origin artifact.
`ArtifactDetailSoapList`	`getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns)`	Deprecated. in favor of getCrossTrackerArtifactList2
`ArtifactDetail2SoapList`	`getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns)`	Returns a filtered list of artifacts within the specified container (project or tracker).
`TrackerFieldSoapDO[]`	`getFields(String sessionId, String trackerId)`	Deprecated. use getFields2 instead
`TrackerField2SoapDO[]`	`getFields2(String sessionId, String trackerId)`	Returns the custom/flex-fields associated with a specific tracker.
`OrderedTrackerFieldSoapList`	`getOrderedTrackerFields(String sessionId, String trackerId)`	Returns all fields and separators in the given tracker with layout information.
`ArtifactDependencySoapList`	`getParentDependencyList(String sessionId, String artifactId)`	Gets the dependency list for an artifact where the artifact is the target artifact.
`Tracker2SoapDO`	`getTracker2Data(String sessionId, String trackerId)`	Deprecated. use getTracker3Data instead, which includes autosum foreign children support
`Tracker2SoapList`	`getTracker2List(String sessionId, String projectId)`	Deprecated. use getTracker3List instead, which includes autosum foreign children support
`Tracker3SoapDO`	`getTracker3Data(String sessionId, String trackerId)`	Returns a data object for a given tracker
`Tracker3SoapList`	`getTracker3List(String sessionId, String projectId)`	Returns a list of trackers for a project in the order that they are displayed in the UI.
`TrackerSoapDO`	`getTrackerData(String sessionId, String trackerId)`	Deprecated. use getTracker3Data instead, which includes tracker unit and autosum foreign children support
`TrackerSoapList`	`getTrackerList(String sessionId, String projectId)`	Deprecated. use getTracker3List instead, which includes tracker unit and autosum foreign children support
`TrackerUnitSoapList`	`getUnitsByProject(String sessionId, String projectId)`	Gets the units for a given project.
`ArtifactSoapDO`	`moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee)`	Deprecated. in favor of moveArtifact2
`Artifact2SoapDO`	`moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee)`	Moves an artifact to a specified target folder.
`void`	`removeArtifactDependency(String sessionId, String originId, String targetId)`	Removes an artifact dependency between two artifacts.
`void`	`reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds)`	Sets a new order of the fields and the separators within a tracker.
`void`	`reorderTrackers(String sessionId, String[] trackerIds)`	Sets a new order of the trackers within a project.
`void`	`setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId)`	Deprecated. in favor of setArtifactData4
`void`	`setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments)`	Deprecated. in favor of setArtifactData4
`void`	`setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments)`	Deprecated. in favor of setArtifactData4
`void`	`setArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments)`	Sets data associated along with multiple attachments with the specified artifact.
`void`	`setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, 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(String sessionId, String objectId, TrackerFieldSoapDO fieldData)`	Deprecated. use setField2 instead
`void`	`setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData)`	Sets a custom/flex-field that is associated with a specific folder (e.g.
`void`	`setTracker2Data(String sessionId, Tracker2SoapDO trackerData)`	Deprecated. use setTracker3Data instead, which includes autosum foreign children support
`void`	`setTracker3Data(String sessionId, Tracker3SoapDO trackerData)`	Sets data on a specific tracker with autosum foreign children support
`void`	`setTrackerData(String sessionId, TrackerSoapDO trackerData)`	Deprecated. use setTracker3Data instead, which includes tracker unit and autosum foreign children support

Class TrackerAppSoap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.collabnet.ce.soap60.webservices.WebService

Methods inherited from class java.lang.Object

Field Detail

WORKFLOW_FIELD_NAME_COMMENT

WORKFLOW_FIELD_NAME_ATTACHMENT

WORKFLOW_FIELD_NAME_ASSIGNEDTO

WORKFLOW_FIELD_NAME_ESTIMATED_HOURS

WORKFLOW_FIELD_NAME_ACTUAL_HOURS

WORKFLOW_FIELD_NAME_REPORTED_IN_RELEASE

WORKFLOW_FIELD_NAME_RESOLVED_IN_RELEASE

WORKFLOW_FIELD_NAME_ESTIMATED_EFFORT

WORKFLOW_FIELD_NAME_ACTUAL_EFFORT

WORKFLOW_FIELD_NAME_REMAINING_EFFORT

WORKFLOW_STATUS_VALUE_ANY

WORKFLOW_STATUS_VALUE_NEW_ARTIFACT

UNKNOWN_RELEASE

Constructor Detail

TrackerAppSoap

Method Detail

getTrackerList

getTracker2List

getTracker3List

getTrackerData

getTracker2Data

getTracker3Data

setTrackerData

setTracker2Data

setTracker3Data

createTracker

createTracker2

createTracker3

setField

setField2

addTextField

addSingleSelectChildField

addSingleSelectField

addMultiSelectField

addUserSelectField

addDateField

deleteField

getFields

getFields2

addSeparator

deleteSeparator

getOrderedTrackerFields

reorderTrackerFields

getArtifactList

getArtifactList2

getCrossTrackerArtifactList

getCrossTrackerArtifactList2

getArtifactDetailList

getArtifactDetailList2

findArtifacts

findArtifacts2

getArtifactData

getArtifactData2

getArtifactData3

setArtifactData

setArtifactData2

setArtifactData3

setArtifactData4

createArtifact

createArtifact2

createArtifact3

createArtifact4

moveArtifact

moveArtifact2

deleteArtifact

getAllowedWorkflowTransitionList

getAllowedWorkflowTransitionList2

copyWorkflowTransitions

cloneTracker

cloneTrackerAcrossProject

createArtifactDependency

removeArtifactDependency

setArtifactRank