public interface ITrackerAppSoap
Tracker2Soap
objects.Tracker2Soap
objects.Tracker2Soap
objects.Tracker2SoapList
objects.ArtifactDetail2SoapList
objects.ArtifactDetail2SoapList
objects.TrackerArtifactDependency2List
.TrackerArtifactDependency2List
.Artifact2SoapList
objects.Artifact2SoapDO
object.Artifact2SoapDO
objects.TrackerField2SoapDO
objects.TrackerField2SoapDO
objects.Artifact2SoapDO
objects.Artifact2SoapDO
objects.Modifier and Type | Method and 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,
com.collabnet.ce.soap60.types.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,
com.collabnet.ce.soap60.types.SoapFieldValues flexFields,
String attachmentFileName,
String attachmentMimeType,
String attachmentFileId)
Deprecated.
in favor of createArtifact3
|
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,
com.collabnet.ce.soap60.types.SoapFieldValues flexFields,
AttachmentSoapDO[] attachments)
Deprecated.
in favor of createArtifact3
|
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,
com.collabnet.ce.soap60.types.SoapFieldValues flexFields,
AttachmentSoapDO[] attachments)
Creates a new artifact with calculate the autosumming_point attachments.
|
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)
Gets workflow transitions for the tracker.
|
ArtifactSoapDO |
getArtifactData(String sessionId,
String artifactId)
Deprecated.
in favor of getArtifactData2
|
Artifact2SoapDO |
getArtifactData2(String sessionId,
String artifactId)
Returns data associated with the specified artifact.
|
ArtifactDetailSoapList |
getArtifactDetailList(String sessionId,
String trackerId,
String[] selectedColumns,
com.collabnet.ce.soap60.types.SoapFilter[] filters,
com.collabnet.ce.soap60.types.SoapSortKey[] sortKeys,
int startIndex,
int maxRows,
boolean exceptionIfExpiredCache,
boolean forceNewQuery)
Deprecated.
in favor of getArtifactDetailList2
|
ArtifactDetail2SoapList |
getArtifactDetailList2(String sessionId,
String trackerId,
String[] selectedColumns,
com.collabnet.ce.soap60.types.SoapFilter[] filters,
com.collabnet.ce.soap60.types.SoapSortKey[] sortKeys,
int startIndex,
int maxRows,
boolean exceptionIfExpiredCache,
boolean forceNewQuery)
Returns a filtered and ordered list of artifacts from the specified tracker.
|
ArtifactSoapList |
getArtifactList(String sessionId,
String containerId,
com.collabnet.ce.soap60.types.SoapFilter[] filters)
Deprecated.
in fovor of getArtifactList2
|
Artifact2SoapList |
getArtifactList2(String sessionId,
String containerId,
com.collabnet.ce.soap60.types.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,
com.collabnet.ce.soap60.types.SoapFilter[] filters,
String[] selectedColumns)
Deprecated.
in favor of getCrossTrackerArtifactList2
|
ArtifactDetail2SoapList |
getCrossTrackerArtifactList2(String sessionId,
String containerId,
com.collabnet.ce.soap60.types.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 setArtifactData3
|
void |
setArtifactData2(String sessionId,
ArtifactSoapDO artifactData,
String comment,
AttachmentSoapDO[] attachments)
Deprecated.
in favor of setArtifactData3
|
void |
setArtifactData3(String sessionId,
Artifact2SoapDO 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. tracker).
|
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
|
TrackerSoapList getTrackerList(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Tracker2SoapList getTracker2List(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Tracker3SoapList getTracker3List(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
TrackerSoapDO getTrackerData(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- Tracker id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Tracker2SoapDO getTracker2Data(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- Tracker id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Tracker3SoapDO getTracker3Data(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- Tracker id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void setTrackerData(String sessionId, TrackerSoapDO trackerData) throws RemoteException
sessionId
- User session id.trackerData
- Detailed data on the tracker to set.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or field or icon could not be found.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when invalid data is specified.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object version mismatches the application server.RemoteException
void setTracker2Data(String sessionId, Tracker2SoapDO trackerData) throws RemoteException
sessionId
- User session id.trackerData
- Detailed data on the tracker to set.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or field or icon could not be found.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when invalid data is specified.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object version mismatches the application server.RemoteException
void setTracker3Data(String sessionId, Tracker3SoapDO trackerData) throws RemoteException
sessionId
- User session id.trackerData
- Detailed data on the tracker to set.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or field or icon could not be found.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when invalid data is specified.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object version mismatches the application server.RemoteException
TrackerSoapDO createTracker(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon) throws RemoteException
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")com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or icon could not be found.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if an existing tracker already existsRemoteException
Tracker2SoapDO createTracker2(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId) throws RemoteException
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 unitcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or icon could not be found.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if an existing tracker already existsRemoteException
Tracker3SoapDO createTracker3(String sessionId, String projectId, String trackerName, String trackerTitle, String trackerDescription, String icon, String trackerUnitId, boolean autosumForeignChildren) throws RemoteException
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 projectscom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or icon could not be found.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if an existing tracker already existscom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedRemoteException
void setField(String sessionId, String objectId, TrackerFieldSoapDO fieldData) throws RemoteException
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 foldercom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specified. See FaultSummary for detail for the following: - DUPLICATE_FIELD_VALUE - ILLEGAL_FIELD_VALUE - INVALID_FIELD_VALUE - INVALID_DEFAULT_VALUE - INVALID_FIELD_OPTIONS_REQUIRED_DISABLED - INVALID_FIELD_VALUE_LENGTH - REQUIRED_FIELD_MISSING - INVALID_FIELD_PATTERNcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowed. See FaultSummary for detail for the following: - INVALID_OPTION_DISABLE_RESERVED_FIELD - INVALID_OPTION_DISABLE_IN_USE_FIELDcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.DependencyViolationFault
- if changing a status violates artifact dependencyRemoteException
FaultSummary
void setField2(String sessionId, String objectId, TrackerField2SoapDO fieldData) throws RemoteException
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 foldercom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specified. See FaultSummary for detail for the following: - DUPLICATE_FIELD_VALUE - ILLEGAL_FIELD_VALUE - INVALID_FIELD_VALUE - INVALID_DEFAULT_VALUE - INVALID_FIELD_OPTIONS_REQUIRED_DISABLED - INVALID_FIELD_VALUE_LENGTH - REQUIRED_FIELD_MISSING - INVALID_FIELD_PATTERNcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowed. See FaultSummary for detail for the following: - INVALID_OPTION_DISABLE_RESERVED_FIELD - INVALID_OPTION_DISABLE_IN_USE_FIELDcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.DependencyViolationFault
- if changing a status violates artifact dependencyRemoteException
FaultSummary
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
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 patterncom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addSingleSelectChildField(String sessionId, String trackerId, String fieldName, String[] fieldValues, String parentFieldId, com.collabnet.ce.soap60.types.SoapNamedValues parentChildFieldValueMap, String helpText) throws RemoteException
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 fieldcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addSingleSelectField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String defaultValue, String helpText) throws RemoteException
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 fieldcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addMultiSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] fieldValues, String[] defaultValues, String helpText) throws RemoteException
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 fieldcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addUserSelectField(String sessionId, String trackerId, String fieldName, int displayLines, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String[] defaultValues, String userFilter, String helpText) throws RemoteException
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 fieldcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
TrackerFieldSoapDO.FIELD_USER_FILTER_PROJECT_MEMBER
,
TrackerFieldSoapDO.FIELD_USER_FILTER_ALL
void addDateField(String sessionId, String trackerId, String fieldName, boolean isRequired, boolean isDisabled, boolean isHiddenOnCreate, String helpText) throws RemoteException
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 fieldcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- if the object has been updated since this fieldDO was fetchedcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void deleteField(String sessionId, String objectId, String fieldId) throws RemoteException
sessionId
- User session id.objectId
- Object (e.g. tracker).fieldId
- the id of the field to deletecom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id or fieldData is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowed.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
TrackerFieldSoapDO[] getFields(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- The tracker for which to return field information.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
TrackerField2SoapDO[] getFields2(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- The tracker for which to return field information.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addSeparator(String sessionId, String trackerId, String separatorType, String separatorLabel) throws RemoteException
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 separatorcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if a separator with the same id existsRemoteException
void deleteSeparator(String sessionId, String trackerId, String layoutId) throws RemoteException
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.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalidcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the arguments are incorrectly specifiedcom.collabnet.ce.soap60.fault.InvalidOperationFault
- if the operation is not allowedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
OrderedTrackerFieldSoapList getOrderedTrackerFields(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- The tracker for which to return field information.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void reorderTrackerFields(String sessionId, String trackerId, String[] layoutIds) throws RemoteException
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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- When the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When any of the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If invalid argument value is passed.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- When the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- When an unexpected system level error occurs.RemoteException
ArtifactSoapList getArtifactList(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
filters
) for filtering artifact lists.sessionId
- User session id.containerId
- ID of a project or a tracker.filters
- Array of filters to apply (null to return unfiltered list).com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Artifact2SoapList getArtifactList2(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters) throws RemoteException
sessionId
- User session id.containerId
- ID of a project or a tracker.filters
- Array of filters to apply (null to return unfiltered list).com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactDetailSoapList getCrossTrackerArtifactList(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters, String[] selectedColumns) throws RemoteException
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_CATEGORYcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactDetail2SoapList getCrossTrackerArtifactList2(String sessionId, String containerId, com.collabnet.ce.soap60.types.SoapFilter[] filters, String[] selectedColumns) throws RemoteException
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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactDetailSoapList getArtifactDetailList(String sessionId, String trackerId, String[] selectedColumns, com.collabnet.ce.soap60.types.SoapFilter[] filters, com.collabnet.ce.soap60.types.SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException
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.
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_CATEGORYfilters
- 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_PRIORITYstartIndex
- 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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactDetail2SoapList getArtifactDetailList2(String sessionId, String trackerId, String[] selectedColumns, com.collabnet.ce.soap60.types.SoapFilter[] filters, com.collabnet.ce.soap60.types.SoapSortKey[] sortKeys, int startIndex, int maxRows, boolean exceptionIfExpiredCache, boolean forceNewQuery) throws RemoteException
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.
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_POINTSstartIndex
- 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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.InvalidFilterFault
- when the specified filters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactSoapList findArtifacts(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException
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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified query string is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
Artifact2SoapList findArtifacts2(String sessionId, String queryString, String projectId, boolean searchAttachments) throws RemoteException
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.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified query string is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
ArtifactSoapDO getArtifactData(String sessionId, String artifactId) throws RemoteException
sessionId
- User session id.artifactId
- Artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
Artifact2SoapDO getArtifactData2(String sessionId, String artifactId) throws RemoteException
sessionId
- User session id.artifactId
- Artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void setArtifactData(String sessionId, ArtifactSoapDO artifactData, String comment, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws RemoteException
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 nullcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object data is stale.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer valid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when workflow rule is violatedcom.collabnet.ce.soap60.fault.DependencyViolationFault
- when dependency rule is violatedcom.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
void setArtifactData2(String sessionId, ArtifactSoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- Comment associated with the change.attachments
- attached file Listcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object data is stale.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer valid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when workflow rule is violatedcom.collabnet.ce.soap60.fault.DependencyViolationFault
- when dependency rule is violatedcom.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
void setArtifactData3(String sessionId, Artifact2SoapDO artifactData, String comment, AttachmentSoapDO[] attachments) throws RemoteException
sessionId
- User session id.artifactData
- the data associated with the artifact at the given pathcomment
- Comment associated with the change.attachments
- attached file Listcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the object data is stale.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer valid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when workflow rule is violatedcom.collabnet.ce.soap60.fault.DependencyViolationFault
- when dependency rule is violatedcom.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
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, com.collabnet.ce.soap60.types.SoapFieldValues flexFields, String attachmentFileName, String attachmentMimeType, String attachmentFileId) throws RemoteException
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 nullcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
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, com.collabnet.ce.soap60.types.SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws RemoteException
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)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
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, com.collabnet.ce.soap60.types.SoapFieldValues flexFields, AttachmentSoapDO[] attachments) throws RemoteException
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)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the artifact data is invalid.com.collabnet.ce.soap60.fault.InconsistentFieldValueFault
- when field hierarchy has been changed and the values are no longer validcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ArtifactSoapDO moveArtifact(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException
sessionId
- User session id.artifactId
- ID of artifact to move.targetFolderId
- Target folder ID.newAssignee
- The username to assign the newly moved artifact to.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when an invalid argument is passed in.com.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
Artifact2SoapDO moveArtifact2(String sessionId, String artifactId, String targetFolderId, String newAssignee) throws RemoteException
sessionId
- User session id.artifactId
- ID of artifact to move.targetFolderId
- Target folder ID.newAssignee
- The username to assign the newly moved artifact to.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when an invalid argument is passed in.com.collabnet.ce.soap60.fault.PlanningFolderRuleViolationFault
- when planning folder rule is violatedRemoteException
void deleteArtifact(String sessionId, String artifactId) throws RemoteException
sessionId
- User session id.artifactId
- Artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
WorkflowTransitionSoapList getAllowedWorkflowTransitionList(String sessionId, String trackerId) throws RemoteException
sessionId
- User session id.trackerId
- Tracker id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when ...RemoteException
void copyWorkflowTransitions(String sessionId, String srcTrackerId, String dstTrackerId) throws RemoteException
sessionId
- User session id.srcTrackerId
- Tracker id.dstTrackerId
- Tracker id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when the copy of workflow transition cannot be completedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
Tracker2SoapDO cloneTracker(String sessionId, String srcTrackerId, String destTrackerTitle, String destTrackerDescription) throws RemoteException
sessionId
- User session id.srcTrackerId
- Tracker id.destTrackerTitle
- destination Tracker tiledestTrackerDescription
- destination Tracker descriptioncom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if an existing tracker already exists.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
Tracker2SoapDO cloneTrackerAcrossProject(String sessionId, String srcTrackerId, String destProjectId, String destTrackerTitle, String destTrackerDescription) throws RemoteException
sessionId
- User session id.srcTrackerId
- Tracker id.destProjectId
- on which project you need to create a trackerdestTrackerTitle
- destination tracker titledestTrackerDescription
- destination tracker descriptioncom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- if an existing tracker already exists.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
void createArtifactDependency(String sessionId, String originId, String targetId, String desc) throws RemoteException
sessionId
- User session id.originId
- Origin artifact id.targetId
- Target artifact id.desc
- Description for the dependency.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when the copy of workflow transition cannot be completedcom.collabnet.ce.soap60.fault.DependencyViolationFault
- when the creation of the dependency causes violationcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
void removeArtifactDependency(String sessionId, String originId, String targetId) throws RemoteException
sessionId
- User session id.originId
- Origin artifact id.targetId
- Target artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when the copy of workflow transition cannot be completedcom.collabnet.ce.soap60.fault.DependencyViolationFault
- when the creation of the dependency causes violationcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.NoSuchRelationshipFault
- when ...RemoteException
void setArtifactRank(String sessionId, String planningFolderId, String artfToRankId, String artfBeforeId, String artfAfterId) throws RemoteException
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:
- 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.
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 itcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when one of the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified id is invalid.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.InvalidRankFault
- when the requested rank operation is invalidRemoteException
ArtifactDependencySoapList getChildDependencyList(String sessionId, String artifactId) throws RemoteException
sessionId
- User session id.artifactId
- Artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when the copy of workflow transition cannot be completedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
ArtifactDependencySoapList getParentDependencyList(String sessionId, String artifactId) throws RemoteException
sessionId
- User session id.artifactId
- Artifact id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.WorkflowViolationFault
- when the copy of workflow transition cannot be completedcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
void reorderTrackers(String sessionId, String[] trackerIds) throws RemoteException
sessionId
- User session id.trackerIds
- An array of the tracker ids in their new order. All the tracker ids must belong to the same projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- When the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When any of the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- When the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- When an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If invalid argument value is passed.RemoteException
TrackerUnitSoapList getUnitsByProject(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- The id of the project to retrieve the unitscom.collabnet.ce.soap60.fault.InvalidSessionFault
- When the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When any of the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- When the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- When an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If invalid argument value is passed.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.