Class TrackerAppSoapStub
java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.tracker.TrackerAppSoapStub
- All Implemented Interfaces:
ITrackerAppSoap
-
Field Summary
Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
DEFAULT_CLIENT_TIME_OUT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.cloneTracker
(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) Clone Tracker within the same projectcloneTrackerAcrossProject
(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) Clone Tracker across the projectvoid
copyWorkflowTransitions
(String sessionId, String srcTrackerId, String dstTrackerId) Copies workflow transitions between two trackers.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) Creates a new artifact.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) Creates a new artifact with multiple attachments.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) Creates a new artifact with multiple attachments and flag to enable the autosumming_points.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.createTracker
(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) Creates a new tracker with an iconcreateTracker2
(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) Creates a new tracker with an iconcreateTracker3
(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) Creates a new tracker with autosum foreign children supportvoid
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.findArtifacts
(String sessionId, String queryString, String projectId, boolean searchAttachments) Finds a list of artifacts matching a search string.findArtifacts2
(String sessionId, String queryString, String projectId, boolean searchAttachments) Finds a list of artifacts matching a search string.getAllowedWorkflowTransitionList
(String sessionId, String trackerId) Gets workflow transitions for the tracker.getAllowedWorkflowTransitionList2
(String sessionId, String trackerId) Gets workflow transitions for the tracker.getAllowedWorkflowTransitionList3
(String sessionId, String trackerId) Gets workflow transitions for the tracker.getArtifactData
(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactData2
(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactData3
(String sessionId, String artifactId) Returns data associated with the specified artifact.getArtifactDetailList
(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.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.getArtifactList
(String sessionId, String containerId, SoapFilter[] filters) Returns a filtered list of artifacts within the specified container (project or tracker).getArtifactList2
(String sessionId, String containerId, SoapFilter[] filters) Returns a filtered list of artifacts within the specified container (project or tracker).getChildDependencyList
(String sessionId, String artifactId) Gets the dependency list for an artifact where the artifact is the origin artifact.getCrossTrackerArtifactList
(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) Returns a filtered list of artifacts within the specified container (project or tracker).getCrossTrackerArtifactList2
(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) Returns a filtered list of artifacts within the specified container (project or tracker).Returns the custom/flex-fields associated with a specific tracker.getFields2
(String sessionId, String trackerId) Returns the custom/flex-fields associated with a specific tracker.getOrderedTrackerFields
(String sessionId, String trackerId) Returns all fields and separators in the given tracker with layout information.getParentDependencyList
(String sessionId, String artifactId) Gets the dependency list for an artifact where the artifact is the target artifact.getTracker2Data
(String sessionId, String trackerId) Returns a data object for a given trackergetTracker2List
(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getTracker3Data
(String sessionId, String trackerId) Returns a data object for a given trackergetTracker3List
(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getTrackerData
(String sessionId, String trackerId) Returns a data object for a given trackergetTrackerList
(String sessionId, String projectId) Returns a list of trackers for a project in the order that they are displayed in the UI.getUnitsByProject
(String sessionId, String projectId) Gets the units for a given project.moveArtifact
(String sessionId, String artifactId, String targetFolderId, String newAssignee) Moves an artifact to a specified target folder.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) Sets data associated with the specified artifact.void
setArtifactData2
(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) Sets data associated along with multiple attachments with the specified artifact.void
setArtifactData3
(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) Sets data associated along with multiple attachments with the specified artifact.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 artifactsvoid
setField
(String sessionId, String objectId, TrackerFieldSoapDO fieldData) Sets a custom/flex-field that is associated with a specific foldervoid
setField2
(String sessionId, String objectId, TrackerField2SoapDO fieldData) Sets a custom/flex-field that is associated with a specific foldervoid
setTracker2Data
(String sessionId, Tracker2SoapDO trackerData) Sets data on a specific trackervoid
setTracker3Data
(String sessionId, Tracker3SoapDO trackerData) Sets data on a specific tracker with autosum foreign children supportvoid
setTrackerData
(String sessionId, TrackerSoapDO trackerData) Sets data on a specific trackerMethods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub
getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam
-
Constructor Details
-
TrackerAppSoapStub
-
-
Method Details
-
getTrackerList
Description copied from interface:ITrackerAppSoap
Returns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTrackerList
in interfaceITrackerAppSoap
- 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.RemoteException
-
getTracker2List
Description copied from interface:ITrackerAppSoap
Returns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTracker2List
in interfaceITrackerAppSoap
- 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.RemoteException
-
getTracker3List
Description copied from interface:ITrackerAppSoap
Returns a list of trackers for a project in the order that they are displayed in the UI.- Specified by:
getTracker3List
in interfaceITrackerAppSoap
- 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.RemoteException
-
getTrackerData
Description copied from interface:ITrackerAppSoap
Returns a data object for a given tracker- Specified by:
getTrackerData
in interfaceITrackerAppSoap
- 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.RemoteException
-
getTracker2Data
Description copied from interface:ITrackerAppSoap
Returns a data object for a given tracker- Specified by:
getTracker2Data
in interfaceITrackerAppSoap
- 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.RemoteException
-
getTracker3Data
Description copied from interface:ITrackerAppSoap
Returns a data object for a given tracker- Specified by:
getTracker3Data
in interfaceITrackerAppSoap
- 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.RemoteException
-
setTrackerData
Description copied from interface:ITrackerAppSoap
Sets data on a specific tracker- Specified by:
setTrackerData
in interfaceITrackerAppSoap
- 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.RemoteException
-
setTracker2Data
Description copied from interface:ITrackerAppSoap
Sets data on a specific tracker- Specified by:
setTracker2Data
in interfaceITrackerAppSoap
- 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.RemoteException
-
setTracker3Data
Description copied from interface:ITrackerAppSoap
Sets data on a specific tracker with autosum foreign children support- Specified by:
setTracker3Data
in interfaceITrackerAppSoap
- 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.RemoteException
-
createTracker
public TrackerSoapDO createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) throws RemoteException Description copied from interface:ITrackerAppSoap
Creates a new tracker with an icon- Specified by:
createTracker
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.projectId
- The id of the project under which to create the new trackertrackerName
- The name of the new trackertrackerTitle
- The title of the new trackertrackerDescription
- The description of the new trackericon
- 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 existsRemoteException
-
createTracker2
public Tracker2SoapDO createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) throws RemoteException Description copied from interface:ITrackerAppSoap
Creates a new tracker with an icon- Specified by:
createTracker2
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.projectId
- The id of the project under which to create the new trackertrackerName
- The name of the new trackertrackerTitle
- The title of the new trackertrackerDescription
- The description of the new trackericon
- 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 existsRemoteException
-
createTracker3
public Tracker3SoapDO createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) throws RemoteException Description copied from interface:ITrackerAppSoap
Creates a new tracker with autosum foreign children support- Specified by:
createTracker3
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.projectId
- The id of the project under which to create the new trackertrackerName
- The name of the new trackertrackerTitle
- The title of the new trackertrackerDescription
- The description of the new trackericon
- The tracker icon (null or something between "icon_01.png" and "icon_99.png")trackerUnitId
- The tracker unitautosumForeignChildren
- 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 existsIllegalArgumentFault
- if the arguments are incorrectly specifiedRemoteException
-
setField
public void setField(String sessionId, String objectId, TrackerFieldSoapDO fieldData) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets a custom/flex-field that is associated with a specific folder- Specified by:
setField
in interfaceITrackerAppSoap
- 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 invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specified.InvalidOperationFault
- if the operation is not allowed.SystemFault
- when an unexpected system error occurs.DependencyViolationFault
- if changing a status violates artifact dependencyRemoteException
- See Also:
-
setField2
public void setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets a custom/flex-field that is associated with a specific folder- Specified by:
setField2
in interfaceITrackerAppSoap
- 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 invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specified.InvalidOperationFault
- if the operation is not allowed.SystemFault
- when an unexpected system error occurs.DependencyViolationFault
- if changing a status violates artifact dependencyRemoteException
- See Also:
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom text field to a tracker.- Specified by:
addTextField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fielddisplayColumns
- the width of the display areadisplayLines
- the height of the display areaisRequired
- if the field is requiredisDisabled
- if the field is disabledisHiddenOnCreate
- if the field is hidden when first createddefaultValue
- default valuehelpText
- The help text for the fieldpattern
- The field validation pattern- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
addSingleSelectChildField
public void addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, SoapNamedValues parentChildFieldValueMap, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom single select field to a tracker.- Specified by:
addSingleSelectChildField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fieldfieldValues
- Array of valid field valuesparentFieldId
- The id of the parent fieldparentChildFieldValueMap
- soapNamedValues which keeps mapping between parent field values and child valueshelpText
- the help text for the field- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
addSingleSelectField
public void addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom single select field to a tracker.- Specified by:
addSingleSelectField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fieldisRequired
- if the field is requiredisDisabled
- if the field is disabledisHiddenOnCreate
- if the field is hidden when first createdfieldValues
- Array of valid field valuesdefaultValue
- default valuehelpText
- the help text for the field- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom multi select field to a tracker.- Specified by:
addMultiSelectField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fielddisplayLines
- the height of the display areaisRequired
- if the field is requiredisDisabled
- if the field is disabledisHiddenOnCreate
- if the field is hidden when first createdfieldValues
- possible valuesdefaultValues
- default valueshelpText
- the help text for the field- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom User selection field to a tracker.- Specified by:
addUserSelectField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fielddisplayLines
- the height of the display areaisRequired
- if the field is requiredisDisabled
- if the field is disabledisHiddenOnCreate
- if the field is hidden when first createddefaultValues
- default values for this field. Must be valid usernamesuserFilter
- is the filterhelpText
- The help text of the field- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
- See Also:
-
addDateField
public void addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) throws RemoteException Description copied from interface:ITrackerAppSoap
Adds a custom Date field to a tracker.- Specified by:
addDateField
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the field to.fieldName
- the name of the fieldisRequired
- if the field is requiredisDisabled
- if the field is disabledisHiddenOnCreate
- if the field is hidden when first createdhelpText
- the help text of the field- Throws:
NoSuchObjectFault
- when the specified object id or fieldData is invalidInvalidSessionFault
- 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 fetchedIllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
deleteField
Description copied from interface:ITrackerAppSoap
Deletes a custom/flex-field .- Specified by:
deleteField
in interfaceITrackerAppSoap
- 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 invalidInvalidSessionFault
- 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.RemoteException
-
getFields
Description copied from interface:ITrackerAppSoap
Returns the custom/flex-fields associated with a specific tracker.- Specified by:
getFields
in interfaceITrackerAppSoap
- 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.RemoteException
-
getFields2
Description copied from interface:ITrackerAppSoap
Returns the custom/flex-fields associated with a specific tracker.- Specified by:
getFields2
in interfaceITrackerAppSoap
- 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.RemoteException
-
addSeparator
public void addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel) throws RemoteException Description copied from interface:ITrackerAppSoap
Adds a separator to a tracker.- Specified by:
addSeparator
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- The tracker to add the separator to.separatorType
- the type of the separatorseparatorLabel
- the label of the separator- Throws:
NoSuchObjectFault
- when the specified object id is invalidInvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- if the arguments are incorrectly specifiedSystemFault
- when an unexpected system error occurs.ObjectAlreadyExistsFault
- if a separator with the same id existsRemoteException
-
deleteSeparator
public void deleteSeparator(String sessionId, String trackerId, String layoutId) throws RemoteException Description copied from interface:ITrackerAppSoap
Deletes a separator of a tracker layout.- Specified by:
deleteSeparator
in interfaceITrackerAppSoap
- 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 invalidInvalidSessionFault
- when the specified session id is invalid.PermissionDeniedFault
- when the user has insufficient privileges.IllegalArgumentFault
- if the arguments are incorrectly specifiedInvalidOperationFault
- if the operation is not allowedSystemFault
- when an unexpected system error occurs.RemoteException
-
getOrderedTrackerFields
public OrderedTrackerFieldSoapList getOrderedTrackerFields(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns all fields and separators in the given tracker with layout information.- Specified by:
getOrderedTrackerFields
in interfaceITrackerAppSoap
- 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.RemoteException
-
reorderTrackerFields
public void reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets a new order of the fields and the separators within a tracker.- Specified by:
reorderTrackerFields
in interfaceITrackerAppSoap
- 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().- 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.RemoteException
-
getArtifactList
public ArtifactSoapList getArtifactList(String sessionId, String containerId, SoapFilter[] filters) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getArtifactList
in interfaceITrackerAppSoap
- 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.RemoteException
-
getArtifactList2
public Artifact2SoapList getArtifactList2(String sessionId, String containerId, SoapFilter[] filters) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getArtifactList2
in interfaceITrackerAppSoap
- 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.RemoteException
-
getCrossTrackerArtifactList
public ArtifactDetailSoapList getCrossTrackerArtifactList(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getCrossTrackerArtifactList
in interfaceITrackerAppSoap
- 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).- 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.RemoteException
-
getCrossTrackerArtifactList2
public ArtifactDetail2SoapList getCrossTrackerArtifactList2(String sessionId, String containerId, SoapFilter[] filters, String[] selectedColumns) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered list of artifacts within the specified container (project or tracker).- Specified by:
getCrossTrackerArtifactList2
in interfaceITrackerAppSoap
- 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).- 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.RemoteException
-
getArtifactDetailList
public ArtifactDetailSoapList getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered and ordered list of artifacts from the specified tracker.- Specified by:
getArtifactDetailList
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- Tracker id.selectedColumns
- String array of column names to be selected (null to return all columns).filters
- Array of filters to apply (null to return unfiltered list).sortKeys
- Array ofSortKey
to applystartIndex
- 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 result in the cacheforceNewQuery
- 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.RemoteException
-
getArtifactDetailList2
public ArtifactDetail2SoapList getArtifactDetailList2(String sessionId, String trackerId, String[] selectedColumns, SoapFilter[] filters, SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException Description copied from interface:ITrackerAppSoap
Returns a filtered and ordered list of artifacts from the specified tracker.- Specified by:
getArtifactDetailList2
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- Tracker id.See ArtifactSoapDO for filters names constant values
sortKeys
- Array ofSortKey
to apply (null to return a default order list that is by ID).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 exception if it doesn't have the results in the cacheforceNewQuery
- 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.RemoteException
-
findArtifacts
public ArtifactSoapList findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException Description copied from interface:ITrackerAppSoap
Finds a list of artifacts matching a search string.- Specified by:
findArtifacts
in interfaceITrackerAppSoap
- 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.RemoteException
-
findArtifacts2
public Artifact2SoapList findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException Description copied from interface:ITrackerAppSoap
Finds a list of artifacts matching a search string.- Specified by:
findArtifacts2
in interfaceITrackerAppSoap
- 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.RemoteException
-
getArtifactData
Description copied from interface:ITrackerAppSoap
Returns data associated with the specified artifact.- Specified by:
getArtifactData
in interfaceITrackerAppSoap
- 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.RemoteException
-
getArtifactData2
Description copied from interface:ITrackerAppSoap
Returns data associated with the specified artifact.- Specified by:
getArtifactData2
in interfaceITrackerAppSoap
- 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.RemoteException
-
getArtifactData3
Description copied from interface:ITrackerAppSoap
Returns data associated with the specified artifact.- Specified by:
getArtifactData3
in interfaceITrackerAppSoap
- 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.RemoteException
-
setArtifactData
public void setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets data associated with the specified artifact.- Specified by:
setArtifactData
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- 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 violatedDependencyViolationFault
- when dependency rule is violatedPlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
-
setArtifactData2
public void setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData2
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- 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 violatedDependencyViolationFault
- when dependency rule is violatedPlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
-
setArtifactData3
public void setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData3
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- 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 violatedDependencyViolationFault
- when dependency rule is violatedPlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
-
setArtifactData4
public void setArtifactData4(String sessionId, Artifact3SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets data associated along with multiple attachments with the specified artifact.- Specified by:
setArtifactData4
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- 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 violatedDependencyViolationFault
- when dependency rule is violatedPlanningFolderRuleViolationFault
- when planning folder rule is violatedInconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer validRemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Creates a new artifact.- Specified by:
createArtifact
in interfaceITrackerAppSoap
- 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 toflexFields
- 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 validSystemFault
- when an unexpected system error occurs.RemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Creates a new artifact with multiple attachments.- Specified by:
createArtifact2
in interfaceITrackerAppSoap
- 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 toflexFields
- 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 validSystemFault
- when an unexpected system error occurs.RemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Creates a new artifact with multiple attachments and flag to enable the autosumming_points.- Specified by:
createArtifact3
in interfaceITrackerAppSoap
- 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 toteamId
- team, this artifact belongs toflexFields
- 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 validSystemFault
- when an unexpected system error occurs.RemoteException
-
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 RemoteException Description copied from interface:ITrackerAppSoap
Creates a new artifact with multiple attachments, flag to enable the autosumming_points and tags.- Specified by:
createArtifact4
in interfaceITrackerAppSoap
- 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 toteamId
- team, this artifact belongs toflexFields
- Flex field values.attachments
- attached file List (or null)tagNames
- tag names- 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 validRemoteException
-
moveArtifact
public ArtifactSoapDO moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException Description copied from interface:ITrackerAppSoap
Moves an artifact to a specified target folder.- Specified by:
moveArtifact
in interfaceITrackerAppSoap
- 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 violatedRemoteException
-
moveArtifact2
public Artifact2SoapDO moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException Description copied from interface:ITrackerAppSoap
Moves an artifact to a specified target folder.- Specified by:
moveArtifact2
in interfaceITrackerAppSoap
- 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 violatedRemoteException
-
deleteArtifact
Description copied from interface:ITrackerAppSoap
Deletes an artifact.- Specified by:
deleteArtifact
in interfaceITrackerAppSoap
- 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.RemoteException
-
getAllowedWorkflowTransitionList
public WorkflowTransitionSoapList getAllowedWorkflowTransitionList(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionList
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when ...RemoteException
-
getAllowedWorkflowTransitionList2
public WorkflowTransition2SoapList getAllowedWorkflowTransitionList2(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionList2
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when ...RemoteException
-
copyWorkflowTransitions
public void copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId) throws RemoteException Description copied from interface:ITrackerAppSoap
Copies workflow transitions between two trackers.- Specified by:
copyWorkflowTransitions
in interfaceITrackerAppSoap
- 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 completedSystemFault
- when an unexpected system level error occurs.RemoteException
-
cloneTracker
public Tracker2SoapDO cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) throws RemoteException Description copied from interface:ITrackerAppSoap
Clone Tracker within the same project- Specified by:
cloneTracker
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.srcTrackerId
- Tracker id.destTrackerTitle
- destination Tracker tiledestTrackerDescription
- 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.RemoteException
-
cloneTrackerAcrossProject
public Tracker2SoapDO cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) throws RemoteException Description copied from interface:ITrackerAppSoap
Clone Tracker across the project- Specified by:
cloneTrackerAcrossProject
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.srcTrackerId
- Tracker id.destProjectId
- on which project you need to create a trackerdestTrackerTitle
- destination tracker titledestTrackerDescription
- 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.RemoteException
-
createArtifactDependency
public void createArtifactDependency(String sessionId, String originId, String targetId, String desc) throws RemoteException Description copied from interface:ITrackerAppSoap
Creates an artifact dependency between two artifacts.- Specified by:
createArtifactDependency
in interfaceITrackerAppSoap
- 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 completedDependencyViolationFault
- when the creation of the dependency causes violationSystemFault
- when an unexpected system level error occurs.RemoteException
-
removeArtifactDependency
public void removeArtifactDependency(String sessionId, String originId, String targetId) throws RemoteException Description copied from interface:ITrackerAppSoap
Removes an artifact dependency between two artifacts.- Specified by:
removeArtifactDependency
in interfaceITrackerAppSoap
- 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 completedDependencyViolationFault
- when the creation of the dependency causes violationSystemFault
- when an unexpected system level error occurs.NoSuchRelationshipFault
- when ...RemoteException
-
setArtifactRank
public void setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, String artfAfterId) throws RemoteException Description copied from interface:ITrackerAppSoap
Sets the rank of an artifact relative to one or more other artifacts- Specified by:
setArtifactRank
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.planningFolderId
- the id of the planning folder in which we are doing the rankartfToRankId
- the artifact to rankartfBeforeId
- the artifact that should be before itartfAfterId
- 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 invalidRemoteException
-
getChildDependencyList
public ArtifactDependencySoapList getChildDependencyList(String sessionId, String artifactId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets the dependency list for an artifact where the artifact is the origin artifact.- Specified by:
getChildDependencyList
in interfaceITrackerAppSoap
- 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 completedSystemFault
- when an unexpected system level error occurs.RemoteException
-
getParentDependencyList
public ArtifactDependencySoapList getParentDependencyList(String sessionId, String artifactId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets the dependency list for an artifact where the artifact is the target artifact.- Specified by:
getParentDependencyList
in interfaceITrackerAppSoap
- 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 completedSystemFault
- when an unexpected system level error occurs.RemoteException
-
reorderTrackers
Description copied from interface:ITrackerAppSoap
Sets a new order of the trackers within a project.- Specified by:
reorderTrackers
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerIds
- An array of the tracker ids in their new order.- 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.RemoteException
-
getUnitsByProject
public TrackerUnitSoapList getUnitsByProject(String sessionId, String projectId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets the units for a given project.- Specified by:
getUnitsByProject
in interfaceITrackerAppSoap
- 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.RemoteException
-
getAllowedWorkflowTransitionList3
public WorkflowTransition3SoapList getAllowedWorkflowTransitionList3(String sessionId, String trackerId) throws RemoteException Description copied from interface:ITrackerAppSoap
Gets workflow transitions for the tracker.- Specified by:
getAllowedWorkflowTransitionList3
in interfaceITrackerAppSoap
- Parameters:
sessionId
- User session id.trackerId
- Tracker id.- Returns:
- Workflow definitions list.
- Throws:
InvalidSessionFault
- when the specified session id is invalid.NoSuchObjectFault
- when the specified object id is invalid.SystemFault
- when ...RemoteException
-