Interface TrackerWebService
- All Superinterfaces:
Remote
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addApprovee
(String workitemURI, String approveeId) Adds an approvee.boolean
addAssignee
(String workitemURI, String assigneeId) Adds an assignee.boolean
addCategory
(String workitemURI, String categoryId) Adds a Category to a Work Item.addComment
(String parentObjectUri, String title, Text content) Adds a comment to a Work Item, Document, Test Run or as a reply to an existing comment.void
addCommentToActivity
(String activityGlobalId, Text commentText) Adds a comment to the Activity.boolean
addExternalLinkedRevision
(String workitemURI, String repositoryName, String revisionId) Links a revision from an external repository.boolean
addExternallyLinkedItem
(String workitemURI, String linkedExternalWorkitemURI, EnumOptionId role) Adds an external linked Work Item.boolean
addHyperlink
(String workitemURI, String url, EnumOptionId role) Adds a hyperlink.boolean
addLinkedItem
(String workitemURI, String linkedWorkitemURI, EnumOptionId role) Adds a linked Work Item.boolean
addLinkedItemWithRev
(String in0, String in1, EnumOptionId in2, String in3, boolean in4) Adds a linked item to the specific Work Item with a revision.boolean
addLinkedOslcItem
(String workitemURI, String linkedOslcItemURI, EnumOptionId role, String label) Adds an OSLC item.boolean
addLinkedRevision
(String workitemURI, String revisionId) Links a revision.boolean
addPlaningContraint
(String workitemURI, Calendar date, EnumOptionId constraint) Adds a planing constraint.boolean
canCommentActivity
(String activityGlobalId) Returns true if the Activity allows for comments.boolean
canCurrentUserAddCommentToActivity
(String activityGlobalId) Returns true if the current User can comment on the Activity.void
createAttachment
(String workitemURI, String fileName, String title, byte[] data) Creates a new attachment.createBaseline
(String projectId, String name, String description, String revision) Creates a Baseline from the head or particular revision.void
createComment
(String workitemURI, Text content) Deprecated.createCommentNew
(String parentURI, String title, Text content, String[] visibleTo) Deprecated.createDocument
(String projectId, String location, String documentName, String documentTitle, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, String homePageContent) Creates a Document in the given location with the given parameters.createDocumentComment
(String documentURI, Text text) Deprecated.createDocumentCommentReferringWI
(String documentURI, String workItemURI, Text text) Creates a comment referring to a Work Item in the Document.createDocumentCommentReply
(String parentURI, Text text) Deprecated.createFolder
(String projectId, String parentName, String name, String title) Creates and returns a sub folder for parentName folder, if it is notnull
, otherwise it creates a new folder under the "Documents & Pages" root Topic.createModule
(String projectId, String location, String moduleName, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, boolean parentToChild, String homePageContent) Creates a document or an old-style Module/Document in a given location with the given parameters.createWorkItem
(WorkItem content) Creates a new Work Item with the given content.createWorkItemInModule
(String moduleURI, String parentWorkItemURI, WorkItem workItem) Creates a Work Item at a specified position inside the Module/Document.void
createWorkRecord
(String workitemURI, User user, Date date, String timeSpent) Creates a Work Record.void
createWorkRecordWithTypeAndComment
(String workitemURI, User user, Date date, EnumOptionId type, String timeSpent, String comment) Creates a Work Record.void
deleteAttachment
(String workitemURI, String id) Remove an attachment.void
deleteBaseline
(String baselineURI) Deletes the given Baseline.void
deleteModule
(String moduleURI) Deletes a Module/Document.void
deleteWorkItem
(String workitemURI) Deletes a Work Item.void
deleteWorkRecord
(String workitemURI, String workRecordURI) Deletes a Work Record.void
doAutoassign
(String workitemURI) Triggers autoassignement.void
doAutoSuspect
(String workitemURI) Triggers auto suspect.void
editApproval
(String workitemURI, String approveeId, EnumOptionId status) Changes the status of an approval.byte[]
exportDocumentToPDF
(String uri, PdfProperties exportPdfProperties) Export and download a document to PDF.Change[]
generateHistory
(String workitemURI, String[] ignoredFields, String[] fieldOrder) Gets the Work Item's history.getActivityByGlobalId
(String activityGlobalId) Returns the Activity with the given global Id.getAllEnumOptionIdsForId
(String projectID, String enumId) Gets all enumeration option IDs.getAllEnumOptionIdsForKey
(String projectID, String key) Gets all enumeration option IDs.getAllEnumOptionsForId
(String projectID, String enumID) Gets all enumeration options.getAllEnumOptionsForKey
(String projectID, String key) Gets all enumeration options.User[]
getAllowedApprovers
(String workitemURI) Gets all allowed approvers.User[]
getAllowedAssignees
(String workitemURI) Gets all allowed assignees.byte[]
getAttachment
(String workitemURI, String attachmentId) Download an attachment.getAvailableActions
(String workitemURI) Gets the actions that can be used on the workflow object in its current state.getAvailableEnumOptionIdsForId
(String workitemURI, String enumID) Gets the available enumeration option IDs.getAvailableEnumOptionIdsForKey
(String workitemURI, String key) Gets the available enumeration option IDs.getBackLinkedWorkitems
(String workitemURI) Gets the back linked Work Items.Category[]
getCategories
(String projectId) Get the categories defined for the give project id.Folder[]
getChildFolders
(String projectId, String parentFolderId) Returns list of folders contained in this folder.getCustomField
(String workitemURI, String key) Gets a Work Item's custom field.String[]
getCustomFieldKeys
(String workitemURI) Gets the names of defined custom fields.getCustomFieldType
(String workitemURI, String key) Gets the custom field definitions for a specific Work Item.getCustomFieldTypes
(String workitemURI) Gets all custom field definitions for a specific Work Item.getDefaultLanguageDefinition
(String projectId) Returns the language definition for the default language.String[]
getDefinedCustomFieldKeys
(String projectID, String typeID) Gets all custom field keys defined for a Work Item Type in a Project.getDefinedCustomFieldType
(String projectID, String typeID, String key) Gets a custom field definition for a Work Item Type.getDefinedCustomFieldTypes
(String projectID, String typeID) Gets all custom field definitions for a Work Item Type.String[]
getDocumentSpaces
(String projectId) Returns Module/Document Spaces from given Project.float
getDurationHours
(String duration) Gets duration time in hoursgetEnumControlKeyForId
(String projectID, String enumID) Gets the enumeration control key for the specified Work Item key.getEnumControlKeyForKey
(String projectID, String key) Gets the enumeration control key for the specified Work Item key.getEnumOptionFromObjectUriForId
(String uri, String enumId) Returns an instance of the IEnumOption of a given object URI and the enumeration Id.getEnumOptionFromObjectUriForKey
(String uri, String prototypeName, String key) Returns an instance of the IEnumOption of a given object URI, the Prototype name and the prototype object's key.getEnumOptionsForId
(String workitemURI, String enumID) Gets the available enumeration options.getEnumOptionsForIdWithControl
(String projectID, String enumID, String controlValue) Gets the available enumeration options.getEnumOptionsForKey
(String workitemURI, String key) Gets the available enumeration options.getEnumOptionsForKeyWithControl
(String projectID, String key, String controlValue) Gets the available enumeration options.getEnumOptionWithEnumId
(String workitemURI, String enumID, EnumOptionId id) Gets an enumeration option.getEnumOptionWithKey
(String workitemURI, String key, EnumOptionId id) Gets an enumeration option.getFilteredEnumOptionsForKey
(String uri, String key, String filter) Gets the available, filtered enumeration options.Returns a folder specified by the Project and Folder name.getFolderForURI
(String objectURI) Returns the folder that the specified object is contained in.Folder[]
getFolders
(String projectId) Returns folders from the given Project or on the Global level.getInitialWorkflowAction
(String workitemURI) Gets the initial workflow action for the specified object and returnsnull
if there is no initial action for the corresponding workflow.getInitialWorkflowActionForProjectAndType
(String projectId, EnumOptionId wiType) Gets the initial workflow action for a specific Work Item Type in the specific Project.getLanguageDefinition
(String projectId, String language) Returns the language definition for a given language.getLanguageDefinitions
(String projectId) Returns all language definitions.getLinkedResources
(String workitemURI) Returns a set of resources linked to the Work Item.getLocalizedWorkItemDescription
(String uri, String language) Returns the localized description or the normal description if the localized one is not defined or is empty.getLocalizedWorkItemDescriptionField
(String projectId, String language, EnumOptionId type) Returns the Id of the field of a Work Item of a given Type that stores the localized description.getLocalizedWorkItemTitle
(String uri, String language) Returns the localized title or normal title if the localized one is not defined or is empty.getLocalizedWorkItemTitleField
(String projectId, String language, EnumOptionId type) Returns the Id of the field of a Work Item of a given Type that stores the localized title.getModuleByLocation
(String projectId, String location) Retrieves the Module/Document on the given location.getModuleByLocationWithFields
(String projectId, String location, String[] fields) Retrieves the Module/Document on the given location with the given fields set.getModuleByUri
(String uri) Gets Module/Document with all fields filled.getModuleByUriWithFields
(String uri, String[] fields) Gets a Module/Document with given fields filled in.Module[]
getModules
(String projectId, String location) Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.String[]
getModulesSubFolders
(String projectId, String location) Returns the sub-folders of a given location relative to the "modules" folder of the given Project.Module[]
getModulesWithFields
(String projectId, String location, String[] fields) Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.String[]
getModuleUris
(String projectId, String location) Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.WorkItem[]
getModuleWorkItems
(String moduleURI, String parentWorkItemURI, boolean deep, String[] fields) Returns Work Items (with given fields set) contained in a given Module/Document under the given parent (if specified).String[]
getModuleWorkItemUris
(String moduleURI, String parentWorkItemURI, boolean deep) Returns the URIs of Work Items contained in a given Module/Document under given parent (if specified).long
Gets the length of one daygetRevision
(String repositoryName, String revisionId) Gets a revision.getRevisionByUri
(String revisionURI) Gets a revision.String[]
getRevisions
(String in0) Returns all revisions for a specific URI.Folder[]
getRootFolders
(String projectId) Returns parent folders from the given Project or on the Global level.getTimepoints
(String projectId) Gets the time points available for a Project.getUnavailableActions
(String workitemURI) Gets the actions that can not be used on the Work Item in the current state because of unsatisfied condition(s).getWikiPageByUri
(String uri) Returns a Wiki Page with the given SubterraURI.getWikiPageByUriWithFields
(String uri, String[] fields) Returns a Wiki Page with the given SubterraURI.WikiPage[]
getWikiPages
(String projectId, String spaceId) Returns Wiki Pages from a given Project and Space.WikiPage[]
getWikiPagesWithFields
(String projectId, String spaceId, String[] fields) Returns Wiki Pages from a given Project and Space.String[]
getWikiPageUris
(String projectId, String spaceId) Returns Wiki Pages from a given Project and Space.String[]
getWikiSpaces
(String projectId) Returns Wiki spaces from a given Project.getWorkItemById
(String projectId, String workitemId) Gets a Work Item with all fields set.getWorkItemByIdsWithFields
(String projectId, String workitemId, String[] keys) Gets a Work Item with only the fields specified filled in with values.getWorkItemByUri
(String uri) Gets a Work Item with all fields set.getWorkItemByUriInRevision
(String uri, String revision) Gets a Work Item in the given revision with all fields set.getWorkItemByUriInRevisionWithFields
(String uri, String revision, String[] keys) Gets a Work Item in a given revision with only the fields specified filled in with values.getWorkItemByUriWithFields
(String uri, String[] keys) Gets a Work Item with only the fields specified filled in with values.int
getWorkItemsCount
(String query) Counts the number of Work Items returned by the given query.WorkItem[]
getWorkItemsLinkedToRevision
(String revisionURI) Gets Work Items linked to a revision.WorkItem[]
getWorkItemsLinkedToRevisionWithFields
(String revisionURI, String[] keys) Gets Work Items linked to a revision.boolean
Returns true if the History is available.boolean
isResolvedComment
(String commentURI) Checks if the comment is in a resolved comments thread.Returns all Activity Sources.Activity[]
listAllActivities
(String query, int count) Returns Activities within the default repository.String[]
listAllActivitiesGlobalIds
(String query, int count) Returns the Activity global IDs within the default repository.Activity[]
listGroupActivities
(String uri, String query, int count) Returns Activities within a given Project group.String[]
listGroupActivitiesGlobalIds
(String uri, String query, int count) Returns global IDs of activities within given project group.Activity[]
listProjectActivities
(String projectId, String query, int count) Returns activities within the given Project.String[]
listProjectActivitiesGlobalIds
(String projectId, String query, int count) Returns the global IDs of Activities within the given Project.void
moveWorkItemToDocument
(String workItemURI, String documentURI, String parentWorkItemURI, int position, boolean retainDocumentFlow) Moves a Work Item to a specific position in a Document.void
moveWorkItemToModule
(String workItemURI, String moduleURI, String parentWorkItemURI, int position) Deprecated.void
performWorkflowAction
(String workitemURI, int actionId) Executes a workflow action.Baseline[]
queryBaselines
(String query, String sort) Queries for Baselines.Module[]
queryModules
(String query, String sort, String[] fields, int resultsLimit) Searches for Modules/Documents.Module[]
queryModulesBySQL
(String sqlQuery, String[] fields) Searches for Modules/Documents.Module[]
queryModulesInBaseline
(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) Searches for the Modules/Documents in a given Baseline.Module[]
queryModulesInBaselineBySQL
(String sqlQuery, String baselineRevision, String[] fields) Searches for Modules/Documents in a given Baseline.String[]
queryModuleUris
(String query, String sort, int resultsLimit) Searches for Modules/Documents.String[]
queryModuleUrisBySQL
(String sqlQuery) Searches for Modules/Documents.String[]
queryModuleUrisInBaseline
(String query, String sort, String baselineRevision, int resultsLimit) Searches for Modules/Documents in a given Baseline.String[]
queryModuleUrisInBaselineBySQL
(String sqlQuery, String baselineRevision) Searches for Modules/Documents in a given Baseline.Revision[]
queryRevisions
(String query, String sort, String[] fields) Queries for revisions.String[]
queryRevisionUris
(String query, String sort, boolean includeInternal) Queries for revisions.WikiPage[]
queryWikiPages
(String query, String sort, String[] fields, int resultsLimit) Searches for Wiki Pages.WikiPage[]
queryWikiPagesBySQL
(String sqlQuery, String[] fields) Searches for Wiki Pages.WikiPage[]
queryWikiPagesInBaseline
(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) Searches for Wiki Pages in the given Baseline.WikiPage[]
queryWikiPagesInBaselineBySQL
(String sqlQuery, String baselineRevision, String[] fields) Searches for Wiki Pages in the given Baseline.String[]
queryWikiPageUris
(String query, String sort, int resultsLimit) Searches for Wiki Pages.String[]
queryWikiPageUrisBySQL
(String sqlQuery) Searches for Wiki Pages.String[]
queryWikiPageUrisInBaseline
(String query, String sort, String baselineRevision, int resultsLimit) Searches for Wiki Pages in a given Baseline.String[]
queryWikiPageUrisInBaselineBySQL
(String sqlQuery, String baselineRevision) Searches for Wiki Pages in the given Baseline.WorkItem[]
queryWorkItems
(String query, String sort, String[] fields) Queries for Work Items.WorkItem[]
queryWorkItemsBySQL
(String sqlQuery, String[] fields) Queries for Work Items.WorkItem[]
queryWorkItemsInBaseline
(String query, String sort, String baselineRevision, String[] fields) Queries for Work Items in a given Baseline.WorkItem[]
queryWorkItemsInBaselineBySQL
(String sqlQuery, String baselineRevision, String[] fields) Searches for Work Items in a given Baseline revision.WorkItem[]
queryWorkItemsInBaselineLimited
(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) Queries for Work Items in a Baseline with a given limit.WorkItem[]
queryWorkItemsInRevision
(String query, String sort, String revision, String[] fields) Queries for Work Items.WorkItem[]
queryWorkItemsInRevisionLimited
(String query, String sort, String revision, String[] fields, int resultsLimit) Queries for Work Items.WorkItem[]
queryWorkItemsLimited
(String query, String sort, String[] fields, int resultsLimit) Queries for Work Items.String[]
queryWorkItemUris
(String query, String sort) Query the URIs of a Work Item.String[]
queryWorkItemUrisBySQL
(String sqlQuery) Query the URIs of Work Items.String[]
queryWorkItemUrisInBaseline
(String query, String sort, String baselineRevision) Queries for Work Item URIs in a Baseline.String[]
queryWorkItemUrisInBaselineBySQL
(String sqlQuery, String baselineRevision) Searches for URIs of Work Items in the given Baseline revision.String[]
queryWorkItemUrisInBaselineLimited
(String query, String sort, String baselineRevision, int resultsLimit) Queries for Work Item URIs in a baseline with a given limit.String[]
queryWorkItemUrisLimited
(String query, String sort, int resultsLimit) Query the URIs of a Work Item.void
removeApprovee
(String workitemURI, String approveeId) Removes an approving user.boolean
removeAssignee
(String workitemURI, String assigneeId) Removes an assignee.boolean
removeCategory
(String workitemURI, String categoryId) Removes a Category.boolean
removeExternalLinkedRevision
(String workitemURI, String repositoryName, String revisionId) Removes a revision from an external repository.boolean
removeExternallyLinkedItem
(String workitemURI, String linkedExternalWorkitemURI, EnumOptionId role) Removes an external linked item.boolean
removeHyperlink
(String workitemURI, String url) Removes a hyperlink.boolean
removeLinkedItem
(String workitemURI, String linkedItemURI, EnumOptionId role) Removes a linked item.boolean
removeLinkedRevision
(String workitemURI, String revisionId) Removes a revision.boolean
removePlaningConstraint
(String workitemURI, Calendar date, EnumOptionId constraint) Removes a planing constraint.void
resetWorkflow
(String workflowObjectURI) Resets the workflow for the specified object.reuseDocument
(String sourceURI, String targetProjectId, String targetLocation, String targetName, String targetTitle, boolean updateTitleInDocument, EnumOptionId linkRole, String[] derivedFields) Creates a new Document based on an existing Document.reuseModule
(String sourceURI, String targetProjectId, String targetLocation, String targetName, EnumOptionId linkRole, String[] fields, String[] exceptFields, String[] derivedFields) Creates new Module/Document based on the existing Module/Document.void
setCommentTags
(String commentURI, EnumOptionId[] tags) Sets the tags of a comment.void
setCustomField
(CustomField customField) Sets a custom field of a Work Item.void
setFieldsNull
(String workitemURI, String[] fields) Sets a field to null.void
setLocalizedWorkItemDescription
(String uri, String language, Text description) Sets the localized description.void
setLocalizedWorkItemTitle
(String uri, String language, String title) Sets the localized title.void
setResolvedComment
(String commentURI, boolean resolved) Sets the state of the comment to "Resolved".void
updateAttachment
(String workitemURI, String id, String fileName, String title, byte[] data) Update an existing attachment.void
updateBaseline
(Baseline baseline) Updates the given Baseline.void
updateDerivedDocument
(String documentURI, String revision, boolean autoSuspect) Updates derived Document to the new revision (Baseline).void
updateDerivedModule
(String moduleURI, String revision) Updates derived the Module/Document to the new revision (Baseline).void
updateModule
(Module module) Updates a Module/Document.updateTitleHeadingInDocument
(String documentURI, String title) Updates the first Title Heading in the Document's content.void
updateWorkItem
(WorkItem content) Updates a Work Item.
-
Method Details
-
addApprovee
Adds an approvee.- Parameters:
workitemURI
- The URI of the Work Item to add an approvee to.approveeId
- The Id of the user to add as an approvee.- Throws:
RemoteException
-
addAssignee
Adds an assignee.- Parameters:
workitemURI
- The URI of the Work Item to add the assignee to.assigneeId
- the Id of the user to add as an assignee.- Throws:
RemoteException
-
addCategory
Adds a Category to a Work Item.- Parameters:
workitemURI
- The URI of the Work Item to add the Category to.categoryId
- The Id of the Category to add.- Throws:
RemoteException
-
addComment
Adds a comment to a Work Item, Document, Test Run or as a reply to an existing comment.- Parameters:
parentObjectUri
- The URI of the parent object (not null).title
- The title of the new comment ornull
.content
- The content of the new comment ornull
.- Throws:
RemoteException
- if the title is not null in a Document or reply comment, or if the parent URI is of an object that does not support comments.- Since:
- 3.10.2
-
addCommentToActivity
Adds a comment to the Activity.- Parameters:
activityGlobalId
- The Activity's global Id (not null).commentText
- The comment's text (not null).- Throws:
RemoteException
- Since:
- 3.7.0
-
addExternalLinkedRevision
boolean addExternalLinkedRevision(String workitemURI, String repositoryName, String revisionId) throws RemoteException Links a revision from an external repository.- Parameters:
workitemURI
- The URI of the Work Item to add the revision to.repositoryName
- The Id of the external repository.revisionId
- The Id of the revision to add.- Throws:
RemoteException
- Since:
- 3.5.1
-
addExternallyLinkedItem
boolean addExternallyLinkedItem(String workitemURI, String linkedExternalWorkitemURI, EnumOptionId role) throws RemoteException Adds an external linked Work Item.- Parameters:
workitemURI
- The URI of the Work Item to add the link to.linkedExternalWorkitemURI
- The URI of the target external Work Item the link points to.role
- The role of the link to add.- Throws:
RemoteException
- Since:
- 3.5.0
-
addHyperlink
Adds a hyperlink.- Parameters:
workitemURI
- The URI of the Work Item to add the hyperlink to.url
- The url of the hyperlink to add.role
- The role of the hyperlink to add.- Throws:
RemoteException
-
addLinkedItem
boolean addLinkedItem(String workitemURI, String linkedWorkitemURI, EnumOptionId role) throws RemoteException Adds a linked Work Item.- Parameters:
workitemURI
- The URI of the Work Item to add the link to.linkedWorkitemURI
- The URI of the target Work Item the link points to.role
- The role of the link to add.- Throws:
RemoteException
-
addLinkedItemWithRev
boolean addLinkedItemWithRev(String in0, String in1, EnumOptionId in2, String in3, boolean in4) throws RemoteException Adds a linked item to the specific Work Item with a revision.- Parameters:
in0
- workitemURI The URI of the Work Item to add the link to.in1
- linkedWorkitemURI The URI of the target Work Item the link points to.in2
- role The role of the linked item to add.in3
- revision specific The revision for a linked item (null refers to the HEAD revision).in4
- suspect true if the link should be marked with a suspect flag.- Throws:
RemoteException
- Since:
- 3.4.3
-
addLinkedOslcItem
boolean addLinkedOslcItem(String workitemURI, String linkedOslcItemURI, EnumOptionId role, String label) throws RemoteException Adds an OSLC item.- Parameters:
workitemURI
- The URI of the Work Item to add the link to.linkedOslcItemURI
- The URI of the target resource the link points to.role
- The role of the link to add.label
- The label of the link to add.- Throws:
RemoteException
- Since:
- 3.10.2
-
addLinkedRevision
Links a revision.- Parameters:
workitemURI
- The URI of the Work Item to add the revision to.revisionId
- The Id of the revision to add.- Throws:
RemoteException
-
addPlaningContraint
boolean addPlaningContraint(String workitemURI, Calendar date, EnumOptionId constraint) throws RemoteException Adds a planing constraint.- Parameters:
workitemURI
- The URI of the Work Item to add the planning constraint to.date
- The date of the planning constraint to add.constraint
- The type of constraint to add.- Throws:
RemoteException
-
canCommentActivity
Returns true if the Activity allows for comments.- Parameters:
activityGlobalId
- The Activity's global Id (not null).- Returns:
- true if Activity allows for comments. Otherwise false.
- Throws:
RemoteException
- Since:
- 3.7.0
-
canCurrentUserAddCommentToActivity
Returns true if the current User can comment on the Activity.- Parameters:
activityGlobalId
- The Activity's global Id (not null).- Returns:
- true if the current user can comment on the Activity. Otherwise false.
- Throws:
RemoteException
- Since:
- 3.7.0
-
createAttachment
void createAttachment(String workitemURI, String fileName, String title, byte[] data) throws RemoteException Creates a new attachment.- Parameters:
workitemURI
- The URI of the Work Item to add the attachment to.fileName
- The fileName of the attachment.title
- The title of the attachment.data
- The content of the attachment.- Throws:
RemoteException
- Since:
- 3.3.1
-
createBaseline
Baseline createBaseline(String projectId, String name, String description, String revision) throws RemoteException Creates a Baseline from the head or particular revision.- Parameters:
projectId
- The Project Id (not null).name
- the Baseline's name (not null).description
- The Baseline's description (can be null).revision
- The revision or a null value for the Head revision.- Returns:
- The Created Baseline.
- Throws:
RemoteException
- Since:
- 3.7.1
-
createComment
Deprecated.Creates a comment.- Parameters:
workitemURI
- The URI of the Work Item to create a comment for.content
- The content of the comment to create.- Throws:
RemoteException
-
createCommentNew
String createCommentNew(String parentURI, String title, Text content, String[] visibleTo) throws RemoteException Deprecated.Creates a comment.- Parameters:
parentURI
- The URI of the parent item (either a Work Item or another comment) to create the comment for.title
- The title of the comment.content
- The content of the comment to create.visibleTo
- Who this comment should be visible to.- Throws:
RemoteException
- Since:
- 3.1.2
-
createDocument
String createDocument(String projectId, String location, String documentName, String documentTitle, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, String homePageContent) throws RemoteException Creates a Document in the given location with the given parameters.- Parameters:
projectId
- The Project Id (not null)location
- The document's Space location with one component or null for the default space. (Can be null.)documentName
- The Document's name (not null).documentTitle
- The Document's title (can be null).allowedWITypes
- A single Type can be specified. (Can be null.)structureLinkRole
- The role that defines the hierarchy of the Work Items inside the Document. (Not null.)homePageContent
- The HTML markup for a document home page. (Can be null).- Returns:
- The URI of the created Document.
- Throws:
RemoteException
- Since:
- 3.8.2
-
createDocumentComment
Deprecated.Creates an unreferenced comment in the Document.- Parameters:
documentURI
- The Document SubterraURI.text
- The comment's text.- Returns:
- The SubterraURI of the newly created comment
- Throws:
RemoteException
- Since:
- 3.7.0
-
createDocumentCommentReferringWI
String createDocumentCommentReferringWI(String documentURI, String workItemURI, Text text) throws RemoteException Creates a comment referring to a Work Item in the Document.- Parameters:
documentURI
- The document SubterraURI.workItemURI
- The Work Item SubterraURI.text
- The comment's text.- Returns:
- The SubterraURI of the newly created comment.
- Throws:
RemoteException
- Since:
- 3.7.0
-
createDocumentCommentReply
Deprecated.Creates a comment as a reply to a given parent Comment in the Document.- Parameters:
parentURI
- The parent comment SubterraURI.text
- The comment's text.- Returns:
- The SubterraURI of the newly created comment.
- Throws:
RemoteException
- Since:
- 3.7.0
-
createFolder
Folder createFolder(String projectId, String parentName, String name, String title) throws RemoteException Creates and returns a sub folder for parentName folder, if it is notnull
, otherwise it creates a new folder under the "Documents & Pages" root Topic.- Parameters:
projectId
- The project ID or null for the Global level.parentName
- (ID) must be unique for the whole folder hierarchy.name
- (ID) must be unique for the whole folder hierarchy.title
- The title for the folder.- Throws:
RemoteException
- Since:
- 3.18.1
-
createModule
String createModule(String projectId, String location, String moduleName, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, boolean parentToChild, String homePageContent) throws RemoteException Creates a document or an old-style Module/Document in a given location with the given parameters.- Parameters:
projectId
- the Project Id.location
- The document Space location with a single component (e.g. "_default" for the default space) or null for old-style Modules.moduleName
- The Document/Module name.allowedWITypes
- The allowed Work Item Types. Only one type can be specified.structureLinkRole
- The required, role that defines the hierarchy of Work Items inside the Module/Document.parentToChild
- Always false.homePageContent
- The HTML markup for a document home page or Wiki markup for the old-style Module home page or null if the default is OK.- Returns:
- The URI of the created Module/Document.
- Throws:
RemoteException
- Since:
- 3.4.1
-
createWorkItem
Creates a new Work Item with the given content. The Project and the Type must be set or the Work Item will not be created. The URI MUST NOT be set, otherwise the creation will fail. To create a Work Item in a specific location e.g. a LiveDoc, set the location of the Work Item to the desired target location. To create a Work Item in a specific Module/Document, set the Module/Document of the Work Item to the desired target Module/Document. Please note that some fields in the newly created Work Item will not be changed: assignee, hyperlink, comment, category, created, updated, resolution, linkedWorkItem, linkedWorkItemsDerived, externallyLinkedWorkItems, approvals, workRecords, plannedEnd, plannedStart, plannedInURIs, planningConstraints, linkedRevisions, linkedRevisionsDerived, linkedOslcResources, attachments, outlineNumber Use other methods to adjust your Work Item e.g. createComment, addHyperlink, addAssignee, addLinkedItem, addCategory.- Parameters:
content
- The content of the Work Item to be created.- Throws:
RemoteException
-
createWorkItemInModule
String createWorkItemInModule(String moduleURI, String parentWorkItemURI, WorkItem workItem) throws RemoteException Creates a Work Item at a specified position inside the Module/Document.- Parameters:
moduleURI
- The Module/Document URI.parentWorkItemURI
- The URI of the parent Work Item or null.workItem
- The content of the Work Item to be created.- Returns:
- The URI of the created Work Item.
- Throws:
RemoteException
- Since:
- 3.4.1
-
createWorkRecord
void createWorkRecord(String workitemURI, User user, Date date, String timeSpent) throws RemoteException Creates a Work Record.- Parameters:
workitemURI
- The URI of the Work Item to create a Work Record for.user
- The user for the Work Record.date
- The date of the Work Record.timeSpent
- The time spent for the Work Record.- Throws:
RemoteException
-
createWorkRecordWithTypeAndComment
void createWorkRecordWithTypeAndComment(String workitemURI, User user, Date date, EnumOptionId type, String timeSpent, String comment) throws RemoteException Creates a Work Record.- Parameters:
workitemURI
- The URI of the Work Item to create a Work Record for.user
- The user for the Work Record.date
- The date of the Work Record.type
- The Work Record Type.timeSpent
- The time spent on the Work Record.comment
- The Work Record comment.- Throws:
RemoteException
- Since:
- 3.4.2
-
deleteAttachment
Remove an attachment.- Parameters:
workitemURI
- The URI of the Work Item containing the attachment to be removed.id
- The Id of the attachment to be removed.- Throws:
RemoteException
- Since:
- 3.3.1
-
deleteBaseline
Deletes the given Baseline.- Parameters:
baselineURI
- The Baseline SubterraURI (not null).- Throws:
RemoteException
- Since:
- 3.7.1
-
deleteModule
Deletes a Module/Document.- Parameters:
moduleURI
- The URI of the Module/Document.- Throws:
RemoteException
- Since:
- 3.4.1
-
deleteWorkItem
Deletes a Work Item.- Parameters:
workitemURI
- The URI of the Work Item.- Throws:
RemoteException
- Since:
- 3.20.1
-
deleteWorkRecord
Deletes a Work Record.- Parameters:
workitemURI
- The URI of the Work Item to remove the work record from.workRecordURI
- The URI of the Work Record to remove.- Throws:
RemoteException
-
doAutoSuspect
Triggers auto suspect.- Parameters:
workitemURI
- The URI of the work item to trigger auto suspect for.- Throws:
RemoteException
-
doAutoassign
Triggers autoassignement.- Parameters:
workitemURI
- The URI of the Work Item to trigger autoassignement for.- Throws:
RemoteException
-
editApproval
void editApproval(String workitemURI, String approveeId, EnumOptionId status) throws RemoteException Changes the status of an approval.- Parameters:
workitemURI
- The URI of the Work Item to execute the action for.approveeId
- The Id of the approvee.status
- The new status to set.- Throws:
RemoteException
-
exportDocumentToPDF
Export and download a document to PDF.- Parameters:
uri
- Module/Document URI.exportPdfProperties
- Export parameters. They contain the following properties: paperSize - The size of the exported page. Possible values are A4 (Default), A3, Letter, Legal and Tabloid. orientation - The orientation of the page. Possible values are Portrait (Default) and Landscape. fitToPageWidth - Set to True to fit the content to the width of the page. Default is True. generateBookmarks - Set to True to generate bookmarks. Default is False. includeHeaderFooter - Set to True to include a header, footer, and watermark. Default is True. repeatTableHeaders - Set to True to repeat table headers on every page. Default is True.- Throws:
RemoteException
- Since:
- 3.20.1
-
generateHistory
Change[] generateHistory(String workitemURI, String[] ignoredFields, String[] fieldOrder) throws RemoteException Gets the Work Item's history.- Parameters:
workitemURI
- The URI of the Work Item to get the history for.ignoredFields
- The fields that will be ignored (can be null).fieldOrder
- The order of fields (can be null).- Throws:
RemoteException
- Since:
- 3.3.0
-
getActivityByGlobalId
Returns the Activity with the given global Id.- Parameters:
activityGlobalId
- The Activity's global Id.- Returns:
- The Activity.
- Throws:
RemoteException
- Since:
- 3.7.0
-
getAllEnumOptionIdsForId
Gets all enumeration option IDs.- Parameters:
projectID
- The ID of the Project to get the options for.enumId
- The Id of the enumeration to get the options for.- Throws:
RemoteException
-
getAllEnumOptionIdsForKey
Gets all enumeration option IDs.- Parameters:
projectID
- The Id of the Project to get the options for.key
- The key of the field containing the enumeration to get the option Id for.- Throws:
RemoteException
-
getAllEnumOptionsForId
Gets all enumeration options.- Parameters:
projectID
- The Id of the Project to get the options for.enumID
- The Id of the enumeration to get the options for.- Throws:
RemoteException
-
getAllEnumOptionsForKey
Gets all enumeration options.- Parameters:
projectID
- The Id of the Project to get the options for.key
- The key of the field containing the enumeration to get the options for.- Throws:
RemoteException
-
getAllowedApprovers
Gets all allowed approvers.- Parameters:
workitemURI
- The URI of the Work Item to get the allowed approvers for.- Throws:
RemoteException
- Since:
- 3.5.3
-
getAllowedAssignees
Gets all allowed assignees.- Parameters:
workitemURI
- The URI of the Work Item to get the allowed assignees for.- Throws:
RemoteException
-
getAttachment
Download an attachment.- Parameters:
workitemURI
- The URI of the Work Item.attachmentId
- The ID of the attachment.- Throws:
RemoteException
- Since:
- 3.20.1
-
getAvailableActions
Gets the actions that can be used on the workflow object in its current state. The conditions of the action are checked and those with failed condition(s) are not returned. NOTE: The parameter nameworkitemURI
is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.- Parameters:
workitemURI
- The URI of the WorkflowObject to get the available actions from. (Should not benull
.)- Returns:
- The available actions.
- Throws:
IllegalArgumentException
- if parameter isnull
RemoteException
- See Also:
-
getAvailableEnumOptionIdsForId
EnumOptionId[] getAvailableEnumOptionIdsForId(String workitemURI, String enumID) throws RemoteException Gets the available enumeration option IDs.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration option IDs for.enumID
- The Id of the enumeration to get the option IDs for.- Throws:
RemoteException
-
getAvailableEnumOptionIdsForKey
EnumOptionId[] getAvailableEnumOptionIdsForKey(String workitemURI, String key) throws RemoteException Gets the available enumeration option IDs.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration option IDs for.key
- The Id of the enumeration to get the available option IDs for.- Throws:
RemoteException
-
getBackLinkedWorkitems
Gets the back linked Work Items. (Work Items linking to the specified Work Item.)- Parameters:
workitemURI
- The URI of the Work Item to get the back links for.- Throws:
RemoteException
-
getCategories
Get the categories defined for the give project id.- Throws:
RemoteException
-
getChildFolders
Returns list of folders contained in this folder.- Parameters:
projectId
- The project ID or null for the Global level.parentFolderId
- The parent folder name (ID).- Returns:
- An array of child folders from this parent folder.
- Throws:
RemoteException
- Since:
- 3.18.1
-
getCustomField
Gets a Work Item's custom field.- Parameters:
workitemURI
- The URI of the Work Item to get the custom field from.key
- The custom field's key.- Throws:
RemoteException
-
getCustomFieldKeys
Gets the names of defined custom fields.- Parameters:
workitemURI
- the URI of the work item to get the defined custom fields for.- Throws:
RemoteException
-
getCustomFieldType
Gets the custom field definitions for a specific Work Item.- Parameters:
workitemURI
- The URI of the Work Item.key
- The key of the custom field.- Throws:
RemoteException
-
getCustomFieldTypes
Gets all custom field definitions for a specific Work Item.- Parameters:
workitemURI
- The URI of the Work Item.- Throws:
RemoteException
-
getDefaultLanguageDefinition
Returns the language definition for the default language. (Primarily to provide its label).- Parameters:
projectId
- The Project Id (not null).- Returns:
- The language definition or null if one is not defined.
- Throws:
RemoteException
- Since:
- 3.6.1
-
getDefinedCustomFieldKeys
Gets all custom field keys defined for a Work Item Type in a Project.- Parameters:
projectID
- The Id of the Project.typeID
- The Work Item Type Id.- Throws:
RemoteException
-
getDefinedCustomFieldType
CustomFieldType getDefinedCustomFieldType(String projectID, String typeID, String key) throws RemoteException Gets a custom field definition for a Work Item Type.- Parameters:
projectID
- The Id of the Project.typeID
- The Work Item Type Id.key
- key of the custom field.- Throws:
RemoteException
-
getDefinedCustomFieldTypes
CustomFieldType[] getDefinedCustomFieldTypes(String projectID, String typeID) throws RemoteException Gets all custom field definitions for a Work Item Type.- Parameters:
projectID
- The Id of the Project.typeID
- The Work Item Type Id.- Throws:
RemoteException
-
getDocumentSpaces
Returns Module/Document Spaces from given Project.- Parameters:
projectId
- The Project Id (not null).- Returns:
- An array of Space IDs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getDurationHours
Gets duration time in hours- Parameters:
duration
- The string representation of the duration time.- Throws:
RemoteException
- Since:
- 3.3.0
-
getEnumControlKeyForId
Gets the enumeration control key for the specified Work Item key.- Parameters:
projectID
- The Id of the Project.enumID
- The Id of the enumeration to get the control key for.- Throws:
RemoteException
-
getEnumControlKeyForKey
Gets the enumeration control key for the specified Work Item key.- Parameters:
projectID
- The Id of the Project.key
- The key of the field containing the enumeration to get the control key for.- Throws:
RemoteException
-
getEnumOptionFromObjectUriForId
Returns an instance of the IEnumOption of a given object URI and the enumeration Id.- Parameters:
uri
- The SubterraURI (not null).enumId
- The Id of the enumeration.- Returns:
- An instance of IEnumOption (not null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getEnumOptionFromObjectUriForKey
EnumOption getEnumOptionFromObjectUriForKey(String uri, String prototypeName, String key) throws RemoteException Returns an instance of the IEnumOption of a given object URI, the Prototype name and the prototype object's key.- Parameters:
uri
- The SubterraURI (not null)prototypeName
- The Prototype name.key
- The key of the given prototype object.- Returns:
- The instance of the IEnumOption (not null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getEnumOptionWithEnumId
EnumOption getEnumOptionWithEnumId(String workitemURI, String enumID, EnumOptionId id) throws RemoteException Gets an enumeration option.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration option for.enumID
- The Id of the enumeration.id
- The enumeration option Id.- Throws:
RemoteException
-
getEnumOptionWithKey
EnumOption getEnumOptionWithKey(String workitemURI, String key, EnumOptionId id) throws RemoteException Gets an enumeration option.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration option for.key
- The key of the field containing the enumeration option value.id
- The enumeration option Id.- Throws:
RemoteException
-
getEnumOptionsForId
Gets the available enumeration options.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration options for.enumID
- The id of the enumeration to get the options for.- Throws:
RemoteException
-
getEnumOptionsForIdWithControl
EnumOption[] getEnumOptionsForIdWithControl(String projectID, String enumID, String controlValue) throws RemoteException Gets the available enumeration options. The control value is the string representation of the Work Item value at the field specified by the enumerations control key.- Parameters:
projectID
- The Id of the Project to get the options for.enumID
- The Id of the enumeration to get the options for.controlValue
- The string representation of the control value.- Throws:
RemoteException
- See Also:
-
getEnumOptionsForKey
Gets the available enumeration options.- Parameters:
workitemURI
- The URI of the Work Item to get the enumeration options for.key
- The key of the field containing the enumeration to get the options for.- Throws:
RemoteException
-
getEnumOptionsForKeyWithControl
EnumOption[] getEnumOptionsForKeyWithControl(String projectID, String key, String controlValue) throws RemoteException Gets the available enumeration options. The control value is the string representation of the Work Item value on the field specified by the enumerations control key.- Parameters:
projectID
- The Id of the Project to get the options for.key
- The key of the field containing the enumeration to get the options for.controlValue
- The string representation of the control value.- Throws:
RemoteException
- See Also:
-
getFilteredEnumOptionsForKey
EnumOption[] getFilteredEnumOptionsForKey(String uri, String key, String filter) throws RemoteException Gets the available, filtered enumeration options.- Parameters:
uri
- The URI of the peristent object to get the enumeration options for (not null).key
- The key of the field containing the enumeration to get the options for (not null).filter
- The Id of the enumeration option to use as the "from" value for the dependency mapping. (Can be null.)- Throws:
RemoteException
- Since:
- 3.8.1
-
getFolder
Returns a folder specified by the Project and Folder name.- Parameters:
projectId
- The Project Id or null for the Global level.folderName
- The name of the folder. (Not null.)- Returns:
- The folder from the given Project or on the Global level.(Not null.)
- Throws:
RemoteException
- Since:
- 3.8.3
-
getFolderForURI
Returns the folder that the specified object is contained in. The object must implement the IFolderItem interface (e.g. Module). Otherwise returns null.- Parameters:
objectURI
- The URI of the object. (Not null.)- Returns:
- Folder for specified object. (Can be null.)
- Throws:
RemoteException
- Since:
- 3.8.3
-
getFolders
Returns folders from the given Project or on the Global level.- Parameters:
projectId
- The project Id or null for the Global level.- Returns:
- An array of folders contained within the given Project or on the Global level.
- Throws:
RemoteException
- Since:
- 3.8.3
-
getInitialWorkflowAction
Gets the initial workflow action for the specified object and returnsnull
if there is no initial action for the corresponding workflow. NOTE: The parameter nameworkitemURI
is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.- Parameters:
workitemURI
- The URI of the WorkflowObject to get the available actions from. (Should not benull
.)- Returns:
- The initial workflow action,
null
if no action is configured. - Throws:
IllegalArgumentException
- if parameter isnull
RemoteException
- Since:
- 3.4.3
- See Also:
-
getInitialWorkflowActionForProjectAndType
WorkflowAction getInitialWorkflowActionForProjectAndType(String projectId, EnumOptionId wiType) throws RemoteException Gets the initial workflow action for a specific Work Item Type in the specific Project.- Parameters:
projectId
- The Id of the Project to get the Work Item from.wiType
- The Work Item Type to get the available actions from. (Should not benull
.)- Returns:
- The initial workflow action,
null
if no initial action is configured. - Throws:
IllegalArgumentException
- if wiType isnull
RemoteException
- Since:
- 3.6.1
- See Also:
-
getLanguageDefinition
Returns the language definition for a given language.- Parameters:
projectId
- The Project Id (not null).language
- The language Id (not null).- Returns:
- The language definition or null if one is not defined.
- Throws:
RemoteException
- Since:
- 3.6.1
-
getLanguageDefinitions
Returns all language definitions. (Does not include the default language definition).- Parameters:
projectId
- The Project Id (not null).- Returns:
- All language definitions.
- Throws:
RemoteException
- Since:
- 3.6.1
-
getLinkedResources
Returns a set of resources linked to the Work Item.- Parameters:
workitemURI
- The URI of the Work Item to get linked resources from.- Returns:
- An array of Linked Resources for the specified Work Item.
- Throws:
RemoteException
- Since:
- 3.17.0
-
getLocalizedWorkItemDescription
Returns the localized description or the normal description if the localized one is not defined or is empty.- Parameters:
uri
- The Work Item URI (not null).language
- The language Id or null for the default language.- Returns:
- The localized description (can be null).
- Throws:
RemoteException
- Since:
- 3.6.1
-
getLocalizedWorkItemDescriptionField
String getLocalizedWorkItemDescriptionField(String projectId, String language, EnumOptionId type) throws RemoteException Returns the Id of the field of a Work Item of a given Type that stores the localized description.- Parameters:
projectId
- The Project Id (not null).language
- The language Id (not null).type
- The Work Item Type (not null).- Returns:
- The Id of the field or null if it is not defined.
- Throws:
RemoteException
- Since:
- 3.6.1
-
getLocalizedWorkItemTitle
Returns the localized title or normal title if the localized one is not defined or is empty.- Parameters:
uri
- The Work Item URI (not null).language
- The language Id or null for the default language.- Returns:
- The localized title (can be null).
- Throws:
RemoteException
- Since:
- 3.6.1
-
getLocalizedWorkItemTitleField
String getLocalizedWorkItemTitleField(String projectId, String language, EnumOptionId type) throws RemoteException Returns the Id of the field of a Work Item of a given Type that stores the localized title.- Parameters:
projectId
- The Project Id (not null).language
- The language Id (not null).type
- The Work Item Type (not null).- Returns:
- The Id of the field or null if one is not defined.
- Throws:
RemoteException
- Since:
- 3.6.1
-
getModuleByLocation
Retrieves the Module/Document on the given location.- Parameters:
projectId
- The Project Id.location
- The encoded location of a retrieved Module/Document, relative to the Module/Document root in the given Project. Use the location with a revision set to retrieve a particular revision of the Module/Document.- Throws:
RemoteException
- Since:
- 3.4.1
-
getModuleByLocationWithFields
Module getModuleByLocationWithFields(String projectId, String location, String[] fields) throws RemoteException Retrieves the Module/Document on the given location with the given fields set.- Parameters:
projectId
- The Project Id.location
- The encoded location of retrieved Module/Document, relative to Module/Document root in the given project. Use the location with a revision set to retrieve a particular revision of the Module/Document.fields
- The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.4.1
-
getModuleByUri
Gets Module/Document with all fields filled.- Parameters:
uri
- Module/Document URI- Throws:
RemoteException
- Since:
- 3.4.1
-
getModuleByUriWithFields
Gets a Module/Document with given fields filled in.- Parameters:
uri
- Module/Document URIfields
- The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.4.1
-
getModuleUris
Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.- Parameters:
projectId
- The Project Id (not null).location
- The serialized location relative to the "modules" folder.- Returns:
- An array of Modules/Documents SubterraURIs. (One Module/Document SubterraURI if the location is the location of the Module/Document; can be null.)
- Throws:
RemoteException
- Since:
- 3.6.3
-
getModuleWorkItemUris
String[] getModuleWorkItemUris(String moduleURI, String parentWorkItemURI, boolean deep) throws RemoteException Returns the URIs of Work Items contained in a given Module/Document under given parent (if specified).- Parameters:
moduleURI
- The Module/Document URI.parentWorkItemURI
- The URI of the parent Work Item or null.deep
- true to return Work Items from the whole subtree.- Throws:
RemoteException
- Since:
- 3.4.1
-
getModuleWorkItems
WorkItem[] getModuleWorkItems(String moduleURI, String parentWorkItemURI, boolean deep, String[] fields) throws RemoteException Returns Work Items (with given fields set) contained in a given Module/Document under the given parent (if specified).- Parameters:
moduleURI
- The Module/Document URI.parentWorkItemURI
- The URI of parent Work Item or null.deep
- true to return Work Items from the whole subtree.fields
- The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.4.1
-
getModules
Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.- Parameters:
projectId
- The Project Id (not null).location
- The serialized location relative to the "modules" folder.- Returns:
- An array of Modules/Documents. (One Module/Document if the location is the location of the Module/Document; can be null.)
- Throws:
RemoteException
- Since:
- 3.6.3
-
getModulesSubFolders
Returns the sub-folders of a given location relative to the "modules" folder of the given Project.- Parameters:
projectId
- The Project Id (not null).location
- The serialized location relative to the "modules" folder.- Returns:
- An array of serialized locations (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getModulesWithFields
Module[] getModulesWithFields(String projectId, String location, String[] fields) throws RemoteException Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.- Parameters:
projectId
- The Project Id (not null).location
- The serialized location relative to the "modules" folder.fields
- An array of field names to fill in the returned Modules/Documents (can be null). For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Returns:
- An array of Modules/Documents. (One Module/Document if the location is the location of the Module/Document; can be null.)
- Throws:
RemoteException
- Since:
- 3.6.3
-
getOneDayLength
Gets the length of one day- Throws:
RemoteException
- Since:
- 3.2.3
-
getRevision
Gets a revision.- Parameters:
repositoryName
- The repository name. (Put "default" for the default repository.)revisionId
- The revision name.- Throws:
RemoteException
- Since:
- 3.3.0
-
getRevisionByUri
Gets a revision.- Parameters:
revisionURI
- The URI of the revision.- Throws:
RemoteException
- Since:
- 3.3.0
-
getRevisions
Returns all revisions for a specific URI.- Parameters:
in0
- uri the URI of the persistence object (Work Item, Module/Document, User, etc).- Returns:
- all revisions for the specific URI.
- Throws:
RemoteException
- Since:
- 3.4.3
-
getRootFolders
Returns parent folders from the given Project or on the Global level. Sorted in ascending order by name (or title if present).- Parameters:
projectId
- The project ID or null for the Global level.- Returns:
- An array of folders contained within the given Project or on the Global level.
- Throws:
RemoteException
- Since:
- 3.18.1
-
getTimepoints
Gets the time points available for a Project.- Parameters:
projectId
- The Id of the Projects to get the available time points for.- Throws:
RemoteException
-
getWikiPageByUri
Returns a Wiki Page with the given SubterraURI.- Parameters:
uri
- The SubterraURI (not null).- Returns:
- The Wiki Page (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWikiPageByUriWithFields
Returns a Wiki Page with the given SubterraURI.- Parameters:
uri
- The SubterraURI (not null).fields
- An array of field names to fill in on the returned Wiki Pages (can be null).- Returns:
- The Wiki Page (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWikiPageUris
Returns Wiki Pages from a given Project and Space.- Parameters:
projectId
- The Project Id (not null).spaceId
- The Space Id (not null).- Returns:
- An array of Wiki Pages SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWikiPages
Returns Wiki Pages from a given Project and Space.- Parameters:
projectId
- The Project Id (not null).spaceId
- The Space Id (not null).- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWikiPagesWithFields
WikiPage[] getWikiPagesWithFields(String projectId, String spaceId, String[] fields) throws RemoteException Returns Wiki Pages from a given Project and Space.- Parameters:
projectId
- The Project Id (not null).spaceId
- Space Id (not null).fields
- An array of field names to filled in on the returned Wiki Pages (can be null).- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWikiSpaces
Returns Wiki spaces from a given Project.- Parameters:
projectId
- The Project Id (not null).- Returns:
- An array of Space Ids (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
getWorkItemById
Gets a Work Item with all fields set.- Parameters:
projectId
- The Id of the project that contains the Work Item to get.workitemId
- The Id of the Work Item to get.- Throws:
RemoteException
-
getWorkItemByIdsWithFields
WorkItem getWorkItemByIdsWithFields(String projectId, String workitemId, String[] keys) throws RemoteException Gets a Work Item with only the fields specified filled in with values. All other fields are not transmitted.- Parameters:
projectId
- The Id of the project that contains the Work Item to get.workitemId
- The Id of the Work Item to get.keys
- The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
-
getWorkItemByUri
Gets a Work Item with all fields set.- Parameters:
uri
- the URI of the work item to get.- Throws:
RemoteException
-
getWorkItemByUriInRevision
Gets a Work Item in the given revision with all fields set. Returns null if the work item did not exist in the revision.- Parameters:
uri
- The URI of the Work Item to get.revision
- The revision of the Work Item to get.- Throws:
RemoteException
- Since:
- 3.4.2
-
getWorkItemByUriInRevisionWithFields
WorkItem getWorkItemByUriInRevisionWithFields(String uri, String revision, String[] keys) throws RemoteException Gets a Work Item in a given revision with only the fields specified filled in with values. All other fields are not transmitted. Returns null if the Work Item does not exist in the revision.- Parameters:
uri
- The URI of the Work Item to get.revision
- The revision of the Work Item to get.keys
- The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.4.2
-
getWorkItemByUriWithFields
Gets a Work Item with only the fields specified filled in with values. All other fields are not transmitted.- Parameters:
uri
- The URI of the Work Item to get.keys
- The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
-
getWorkItemsCount
Counts the number of Work Items returned by the given query.- Parameters:
query
- The Lucene query to be used.- Throws:
RemoteException
- Since:
- 3.3.0
-
getWorkItemsLinkedToRevision
Gets Work Items linked to a revision.- Parameters:
revisionURI
- The URI of the revision.- Throws:
RemoteException
- Since:
- 3.3.0
-
getWorkItemsLinkedToRevisionWithFields
WorkItem[] getWorkItemsLinkedToRevisionWithFields(String revisionURI, String[] keys) throws RemoteException Gets Work Items linked to a revision.- Parameters:
revisionURI
- The URI of the revision.keys
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.3.0
-
isHistoryAvailable
Returns true if the History is available.- Returns:
- true if the History is available. Otherwise false.
- Throws:
RemoteException
- Since:
- 3.7.1
-
isResolvedComment
Checks if the comment is in a resolved comments thread.- Parameters:
commentURI
- The URI of the comment.- Throws:
RemoteException
- Since:
- 3.7.1
-
listActivitySources
Returns all Activity Sources.- Returns:
- array of Activity sources.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listAllActivities
Returns Activities within the default repository.- Parameters:
query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activities.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listAllActivitiesGlobalIds
Returns the Activity global IDs within the default repository.- Parameters:
query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activity global IDs.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listGroupActivities
Returns Activities within a given Project group.- Parameters:
uri
- The SubterraURI (not null).query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activities.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listGroupActivitiesGlobalIds
Returns global IDs of activities within given project group.- Parameters:
uri
- The SubterraURI (not null).query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activity global IDs.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listProjectActivities
Returns activities within the given Project.- Parameters:
projectId
- The Id of the Project (not null).query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activities.
- Throws:
RemoteException
- Since:
- 3.7.0
-
listProjectActivitiesGlobalIds
String[] listProjectActivitiesGlobalIds(String projectId, String query, int count) throws RemoteException Returns the global IDs of Activities within the given Project.- Parameters:
projectId
- The Id of the Project (not null).query
- The Lucene query (can be null).count
- The number of results. (-1 will return all results.)- Returns:
- An array of Activity global IDs.
- Throws:
RemoteException
- Since:
- 3.7.0
-
moveWorkItemToDocument
void moveWorkItemToDocument(String workItemURI, String documentURI, String parentWorkItemURI, int position, boolean retainDocumentFlow) throws RemoteException Moves a Work Item to a specific position in a Document. If the Work Item is not yet inside the Document it will be moved into the Document. Modules are also supported.- Parameters:
workItemURI
- The URI of the Work Item to be moved.documentURI
- The URI of the Document.parentWorkItemURI
- The URI of the parent Work Item ornull
to insert it as the root.position
- The desired position in the list of children or a value < 0 to insert the Work Item at the end. (If the old and new parent are the same, then the moved Work Item is not counted.)retainDocumentFlow
-true
to retain the position of the moved Work Item in the document flow, even if it means changing the parent.false
to keep the desired parent, even if it means moving the Work Item to a different position.- Throws:
RemoteException
- Since:
- 3.7.0
-
moveWorkItemToModule
void moveWorkItemToModule(String workItemURI, String moduleURI, String parentWorkItemURI, int position) throws RemoteException Deprecated.Moves a Work Item to a specific position in a Module/Document. If the Work Item is not yet inside the Module/Document it will be moved there. Since 3.7.0 this no longer retains the document flow, but keeps the desired parent.- Parameters:
workItemURI
- The URI of the Work Item to be moved.moduleURI
- The URI of the Module/Document.parentWorkItemURI
- The URI of the parent Work Item ornull
to insert it as the root.position
- The desired position in the list of children or a value < 0 to insert at the end. (If the old and new parent are the same, then the moved Work Item is not counted.)- Throws:
RemoteException
- Since:
- 3.4.3
-
performWorkflowAction
Executes a workflow action. The actions that can be performed can be received bygetAvailableActions(java.lang.String)
. The workflow action is specified byWorkflowAction.getActionId()
. NOTE: The parameter nameworkitemURI
is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.- Parameters:
workitemURI
- The URI of the WorkflowObject to execute the action for (should not benull
).actionId
- The Id of the action to execute.- Throws:
IllegalArgumentException
- if workitemURI parameter isnull
RemoteException
- See Also:
-
queryBaselines
Queries for Baselines.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.- Throws:
RemoteException
- Since:
- 3.4.2
-
queryModuleUris
Searches for Modules/Documents.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).resultsLimit
- Set a limit on how many results to return. (-1 for unlimited.)- Returns:
- An array of Modules/Documents SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModuleUrisBySQL
Searches for Modules/Documents.- Parameters:
sqlQuery
- The SQL statement.- Returns:
- An array of Modules/Documents SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModuleUrisInBaseline
String[] queryModuleUrisInBaseline(String query, String sort, String baselineRevision, int resultsLimit) throws RemoteException Searches for Modules/Documents in a given Baseline.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).baselineRevision
- The Baseline revision.resultsLimit
- Set a limit on how many results to return. (-1 for unlimited.)- Returns:
- An array of Modules/Documents SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModuleUrisInBaselineBySQL
String[] queryModuleUrisInBaselineBySQL(String sqlQuery, String baselineRevision) throws RemoteException Searches for Modules/Documents in a given Baseline.- Parameters:
sqlQuery
- The SQL statement.baselineRevision
- The Baseline revision.- Returns:
- An array of Modules/Documents SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModules
Module[] queryModules(String query, String sort, String[] fields, int resultsLimit) throws RemoteException Searches for Modules/Documents.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null)fields
- An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).resultsLimit
- Sets a limit on the number of results to return.(-1 to return all results without a limit.)- Returns:
- An array of Modules/Documents (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModulesBySQL
Searches for Modules/Documents.- Parameters:
sqlQuery
- The SQL statement.fields
- An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Returns:
- An array of Modules/Documents (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModulesInBaseline
Module[] queryModulesInBaseline(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) throws RemoteException Searches for the Modules/Documents in a given Baseline.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).baselineRevision
- The Baseline revisionfields
- An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).resultsLimit
- how many results to return (-1 means everything)- Returns:
- An array of Modules/Documents (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryModulesInBaselineBySQL
Module[] queryModulesInBaselineBySQL(String sqlQuery, String baselineRevision, String[] fields) throws RemoteException Searches for Modules/Documents in a given Baseline.- Parameters:
sqlQuery
- The SQL statement.baselineRevision
- The Baseline revision.fields
- An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Returns:
- An array of Modules/Documents (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryRevisionUris
String[] queryRevisionUris(String query, String sort, boolean includeInternal) throws RemoteException Queries for revisions.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.includeInternal
- Whether internal Polarion commits should be included.- Throws:
RemoteException
- Since:
- 3.3.0
-
queryRevisions
Queries for revisions.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.fields
- The keys of the fields that should be filled in.- Throws:
RemoteException
- Since:
- 3.3.0
-
queryWikiPageUris
Searches for Wiki Pages.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).resultsLimit
- Limit the number of results to return.(-1 for unlimited.)- Returns:
- An array of Wiki Pages SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPageUrisBySQL
Searches for Wiki Pages.- Parameters:
sqlQuery
- The SQL statement.- Returns:
- An array of Wiki Pages SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPageUrisInBaseline
String[] queryWikiPageUrisInBaseline(String query, String sort, String baselineRevision, int resultsLimit) throws RemoteException Searches for Wiki Pages in a given Baseline.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).baselineRevision
- The Baseline revision.resultsLimit
- Limit the number of results to return.(-1 for unlimited.)- Returns:
- An array of Wiki Pages SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPageUrisInBaselineBySQL
String[] queryWikiPageUrisInBaselineBySQL(String sqlQuery, String baselineRevision) throws RemoteException Searches for Wiki Pages in the given Baseline.- Parameters:
sqlQuery
- The SQL statement.baselineRevision
- The Baseline revision.- Returns:
- An array of Wiki Pages SubterraURIs (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPages
WikiPage[] queryWikiPages(String query, String sort, String[] fields, int resultsLimit) throws RemoteException Searches for Wiki Pages.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).fields
- An array of field names to fill in on the returned Wiki Pages (can be null).resultsLimit
- Limit the maximum number of results to return. (-1 for unlimited.)- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPagesBySQL
Searches for Wiki Pages.- Parameters:
sqlQuery
- The SQL statement.fields
- An array of field names to fill in for the returned Wiki Pages. (Can be null.)- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPagesInBaseline
WikiPage[] queryWikiPagesInBaseline(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) throws RemoteException Searches for Wiki Pages in the given Baseline.- Parameters:
query
- The Lucene query (can be null).sort
- The Lucene sort string (can be null).baselineRevision
- The Baseline revision.fields
- An array of field names to fill in on the returned Wiki Pages. (Can be null.)resultsLimit
- Limits the number of results to return. (-1 for unlimited.)- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWikiPagesInBaselineBySQL
WikiPage[] queryWikiPagesInBaselineBySQL(String sqlQuery, String baselineRevision, String[] fields) throws RemoteException Searches for Wiki Pages in the given Baseline.- Parameters:
sqlQuery
- The SQL statement.baselineRevision
- The Baseline revision.fields
- An array of field names to fill in on the returned Wiki Pages. (Can be null.)- Returns:
- An array of Wiki Pages (can be null).
- Throws:
RemoteException
- Since:
- 3.6.3
-
queryWorkItemUris
Query the URIs of a Work Item.- Parameters:
query
- The Lucene query.sort
- The key used to sort the result.- Throws:
RemoteException
-
queryWorkItemUrisBySQL
Query the URIs of Work Items.- Parameters:
sqlQuery
- the SQL query.- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemUrisInBaseline
String[] queryWorkItemUrisInBaseline(String query, String sort, String baselineRevision) throws RemoteException Queries for Work Item URIs in a Baseline.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.baselineRevision
- The revision that the Work Items should be returned for.- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemUrisInBaselineBySQL
String[] queryWorkItemUrisInBaselineBySQL(String sqlQuery, String baselineRevision) throws RemoteException Searches for URIs of Work Items in the given Baseline revision.- Parameters:
sqlQuery
- The SQL query.baselineRevision
- The Baseline revision that the Work Item should be returned for.- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemUrisInBaselineLimited
String[] queryWorkItemUrisInBaselineLimited(String query, String sort, String baselineRevision, int resultsLimit) throws RemoteException Queries for Work Item URIs in a baseline with a given limit.- Parameters:
query
- the Lucene query to be used.sort
- The field to be used for sorting.baselineRevision
- The revision that the Work Items should be returned for.resultsLimit
- The maximum number of returned Work Items. (-1 for unlimited.)- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemUrisLimited
String[] queryWorkItemUrisLimited(String query, String sort, int resultsLimit) throws RemoteException Query the URIs of a Work Item.- Parameters:
query
- the Lucene query.sort
- The key used to sort the result.resultsLimit
- The maximum number of returned Work Items. (-1 for unlimited.)- Throws:
RemoteException
- Since:
- 3.3.0
-
queryWorkItems
Queries for Work Items.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.fields
- The keys for the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
-
queryWorkItemsBySQL
Queries for Work Items.- Parameters:
sqlQuery
- The SQL query.fields
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemsInBaseline
WorkItem[] queryWorkItemsInBaseline(String query, String sort, String baselineRevision, String[] fields) throws RemoteException Queries for Work Items in a given Baseline.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.baselineRevision
- The revision that the Work Items should be returned for.fields
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemsInBaselineBySQL
WorkItem[] queryWorkItemsInBaselineBySQL(String sqlQuery, String baselineRevision, String[] fields) throws RemoteException Searches for Work Items in a given Baseline revision.- Parameters:
sqlQuery
- The SQL query.baselineRevision
- The Baseline revision in that the Work Items should be returned for.fields
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemsInBaselineLimited
WorkItem[] queryWorkItemsInBaselineLimited(String query, String sort, String baselineRevision, String[] fields, int resultsLimit) throws RemoteException Queries for Work Items in a Baseline with a given limit.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.baselineRevision
- The revision that the Work Items should be returned for.fields
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).resultsLimit
- The maximum number of returned Work Items. (-1 for unlimited.)- Throws:
RemoteException
- Since:
- 3.6.0
-
queryWorkItemsInRevision
WorkItem[] queryWorkItemsInRevision(String query, String sort, String revision, String[] fields) throws RemoteException Queries for Work Items. The search is done in the current state of the Work Items, but the Work Items are returned in the state of the given revision. Work Items that were deleted since the revision are not returned.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.revision
- The revision that the Work Items should be returned to.fields
- The keys of the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).- Throws:
RemoteException
- Since:
- 3.4.2
-
queryWorkItemsInRevisionLimited
WorkItem[] queryWorkItemsInRevisionLimited(String query, String sort, String revision, String[] fields, int resultsLimit) throws RemoteException Queries for Work Items. The search is done in current state of the Work Items, but the Work Items are returned in the state they are in for the given revision. Work Items that were deleted since the revision are not returned.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.revision
- The revision that the Work Items should be returned for.fields
- The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).resultsLimit
- maximal returned number of workitems (-1 means no limit)- Throws:
RemoteException
- Since:
- 3.4.2
-
queryWorkItemsLimited
WorkItem[] queryWorkItemsLimited(String query, String sort, String[] fields, int resultsLimit) throws RemoteException Queries for Work Items.- Parameters:
query
- The Lucene query to be used.sort
- The field to be used for sorting.fields
- The keys of the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).resultsLimit
- The maximum number of returned Work Items. (-1 for unlimited.)- Throws:
RemoteException
- Since:
- 3.3.0
-
removeApprovee
Removes an approving user.- Parameters:
workitemURI
- The URI of the Work Item to remove the approvee from.approveeId
- The Id of the approving user to remove.- Throws:
RemoteException
-
removeAssignee
Removes an assignee.- Parameters:
workitemURI
- The URI of the Work Item to remove the assignee from.assigneeId
- the id of the user to add as an assignee.- Throws:
RemoteException
-
removeCategory
Removes a Category.- Parameters:
workitemURI
- The URI of the Work Item to remove the Category from.categoryId
- The Id of the Category to Remove.- Throws:
RemoteException
-
removeExternalLinkedRevision
boolean removeExternalLinkedRevision(String workitemURI, String repositoryName, String revisionId) throws RemoteException Removes a revision from an external repository.- Parameters:
workitemURI
- The URI of the Work Item to remove the linked revision from.repositoryName
- The Id of the external repository.revisionId
- The Id of the revision to remove.- Throws:
RemoteException
- Since:
- 3.5.1
-
removeExternallyLinkedItem
boolean removeExternallyLinkedItem(String workitemURI, String linkedExternalWorkitemURI, EnumOptionId role) throws RemoteException Removes an external linked item.- Parameters:
workitemURI
- The URI of the Work Item to remove the linked item from.linkedExternalWorkitemURI
- The URI of the linked item to remove.role
- The role of the linked item to remove.- Throws:
RemoteException
- Since:
- 3.5.0
-
removeHyperlink
Removes a hyperlink.- Parameters:
workitemURI
- The URI of the Work Item to remove the hyperlink from.url
- The url of the hyperlink to remove.- Throws:
RemoteException
-
removeLinkedItem
boolean removeLinkedItem(String workitemURI, String linkedItemURI, EnumOptionId role) throws RemoteException Removes a linked item.- Parameters:
workitemURI
- The URI of the Work Item to remove the linked item from.linkedItemURI
- The URI of the linked item to remove.role
- The role of the linked item to remove.- Throws:
RemoteException
-
removeLinkedRevision
Removes a revision.- Parameters:
workitemURI
- The URI of the Work Item to remove the linked revision from.revisionId
- The Id of the revision to remove.- Throws:
RemoteException
-
removePlaningConstraint
boolean removePlaningConstraint(String workitemURI, Calendar date, EnumOptionId constraint) throws RemoteException Removes a planing constraint.- Parameters:
workitemURI
- The URI of the Work Item to remove the planning constraint from.date
- The date of the planning constraint to remove.constraint
- The Type of constraint to remove.- Throws:
RemoteException
-
resetWorkflow
Resets the workflow for the specified object. Performs an initial action if it exists and sets the initial status.- Parameters:
workflowObjectURI
- The URI of the WorkflowObject (should not benull
).- Throws:
IllegalArgumentException
- if the parameter isnull
.RemoteException
- Since:
- 3.8.1
-
reuseDocument
String reuseDocument(String sourceURI, String targetProjectId, String targetLocation, String targetName, String targetTitle, boolean updateTitleInDocument, EnumOptionId linkRole, String[] derivedFields) throws RemoteException Creates a new Document based on an existing Document.- Parameters:
sourceURI
- The URI of the source Document. (Not null.)targetProjectId
- The target Project Id. (Not null.)targetLocation
- The document's Space location with one component or null for the default space. (Can be null.)targetName
- The target Document's name. (Not null.)targetTitle
- The target Document's title. (Can be null.)updateTitleInDocument
- if true then the first title found in the document will be changed to the targetTitle value. (If permissions allow it).linkRole
- The role of links going from a reused Work Item to its source Work Item or null to not create links unless the derivedFields are specified. If this is the case, the links will be created with the default role. (Can be null.)derivedFields
- The fields that are derived from the source Document. (See updateDerivedModule.) (Can be null.)- Returns:
- The URI of the created Document.
- Throws:
RemoteException
- Since:
- 3.8.2
-
reuseModule
String reuseModule(String sourceURI, String targetProjectId, String targetLocation, String targetName, EnumOptionId linkRole, String[] fields, String[] exceptFields, String[] derivedFields) throws RemoteException Creates new Module/Document based on the existing Module/Document.- Parameters:
sourceURI
- The URI of the source Module/Document.targetProjectId
- The target project Id.targetLocation
- ignoredtargetName
- The target Module/Document name.linkRole
- The role of links going from a reused Work Item to a source Work Item or null to not create links unless the derivedFields are specified. (If so, the links will be created with the default role.)fields
- ignoredexceptFields
- ignoredderivedFields
- The fields that are derived from the source Module/Document (see updateDerivedModule).- Returns:
- The URI of the created Module/Document.
- Throws:
RemoteException
- Since:
- 3.4.1
-
setCommentTags
Sets the tags of a comment.- Parameters:
commentURI
- The URI of the comment.tags
- The tags to set.- Throws:
RemoteException
- Since:
- 3.7.1
-
setCustomField
Sets a custom field of a Work Item.- Parameters:
customField
- The custom field to set.- Throws:
RemoteException
-
setFieldsNull
Sets a field to null.- Parameters:
workitemURI
- The URI of the Work Item to set a fields null for.fields
- The keys of the fields to set null.- Throws:
RemoteException
-
setLocalizedWorkItemDescription
void setLocalizedWorkItemDescription(String uri, String language, Text description) throws RemoteException Sets the localized description.- Parameters:
uri
- The Work Item URI (not null).language
- The language Id (must be defined) or null for the default language.description
- The description (can be null).- Throws:
RemoteException
- Since:
- 3.6.1
-
setLocalizedWorkItemTitle
Sets the localized title.- Parameters:
uri
- The Work Item URI (not null).language
- The language Id (must be defined) or null for the default language.title
- The title (can be null).- Throws:
RemoteException
- Since:
- 3.6.1
-
setResolvedComment
Sets the state of the comment to "Resolved". Can only be used for root comments.- Parameters:
commentURI
- The URI of the comment.resolved
- The new resolved state.- Throws:
RemoteException
- Since:
- 3.7.1
-
updateAttachment
void updateAttachment(String workitemURI, String id, String fileName, String title, byte[] data) throws RemoteException Update an existing attachment.- Parameters:
workitemURI
- The URI of the Work Item containing the attachment to be updated.id
- The Id of the attachment to be updated.fileName
- The new filename, will be ignored if null is used.title
- The new title, will be ignored if null is used.data
- The new content, will be ignored if null is used.- Throws:
RemoteException
- Since:
- 3.3.1
-
updateBaseline
Updates the given Baseline.- Parameters:
baseline
- The updated Baseline (not null).- Throws:
RemoteException
- Since:
- 3.7.1
-
updateDerivedDocument
void updateDerivedDocument(String documentURI, String revision, boolean autoSuspect) throws RemoteException Updates derived Document to the new revision (Baseline).- Parameters:
documentURI
- The derived document.revision
- Null refers to the HEAD revisionautoSuspect
-- Throws:
RemoteException
- Since:
- 3.5.3
-
updateDerivedModule
Updates derived the Module/Document to the new revision (Baseline).- Parameters:
moduleURI
- The derived Module/Document.revision
- Null refers to the HEAD revision.- Throws:
RemoteException
- Since:
- 3.4.1
-
updateModule
Updates a Module/Document. Changes for some fields of a passed Module (like array fields) are ignored when calling this method.- Parameters:
module
- updated Module/Document- Throws:
RemoteException
- Since:
- 3.4.1
-
updateTitleHeadingInDocument
Updates the first Title Heading in the Document's content.- Parameters:
documentURI
- The URI of the Document. (Not null.)title
- The Document title. (Can be null.)- Returns:
- The URI of an updated Title Heading or null if no Title Heading in the Document's content was updated.
- Throws:
RemoteException
- Since:
- 3.8.2
-
updateWorkItem
Updates a Work Item. The Work Item passed has to contain the valid URI of the Work Item being updated. Fields that are not transmitted will not be set on the target Work Item. Therefore only the changed fields and the URI should be sent to save resources. Please note that some fields in the updated Work Item: assignee, hyperlink, comment, category, id, created, updated, moduleURI, plannedEnd, plannedStart, plannedInURIs, planningConstraints, author, project, externallyLinkedWorkItems, linkedRevisions, linkedRevisionsDerived, linkedOslcResources, attachments, approvals, workRecords, outlineNumber will not be changed. Use other methods to adjust your updated Work Item e.g. createComment, addHyperlink, addAssignee, addLinkedItem, addCategory.- Parameters:
content
- The altered content.- Throws:
RemoteException
-
addComment(String, String, com.polarion.alm.ws.client.types.Text)
.