SpiraTeam: SoapService SOAP Web Service (v5.0)

This web service enables the import and export of data to/from the system. Each function is prefixed by the area of the system that it relates to. For example, the Requirement_Retrieve function relates to the Requirements module.

This API is available for all installations v5.0 or greater. There are older APIs available for older versions of the system (v4.0, v3.0, v2.2, v1.5.2, v1.2)

The following operations are supported. For a formal definition, please review the Service Description .

Return Value Operation
RemoteAssociationAssociation_Create ( RemoteAssociation?  remoteAssociation, )
Adds a new association in the system
ArrayOfRemoteAssociationAssociation_RetrieveForArtifact ( int artifactTypeId, int artifactId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, )
Retrieves a set of associations to the specified artifact
Association_Update ( RemoteAssociation?  remoteAssociation, )
Updates the specified Association's information
RemoteAutomationEngineAutomationEngine_Create ( RemoteAutomationEngine?  remoteEngine, )
Creates a new Automation Engine in the system.
ArrayOfRemoteAutomationEngineAutomationEngine_Retrieve ( boolean activeOnly, )
Retrieves the list of automation engines in the system
RemoteAutomationEngineAutomationEngine_RetrieveById ( int automationEngineId, )
Retrieves a single automation engine record by its ID
RemoteAutomationEngineAutomationEngine_RetrieveByToken ( string?  token, )
Retrieves a single automation engine record by its Token
AutomationEngine_Update ( RemoteAutomationEngine?  remoteEngine, )
Updates an existing automation engine in the system
RemoteAutomationHostAutomationHost_Create ( RemoteAutomationHost?  remoteAutomationHost, )
Creates a new automation host in the system
AutomationHost_Delete ( int automationHostId, )
Deletes a automation host in the system
ArrayOfRemoteAutomationHostAutomationHost_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves the list of automation hosts in the current project
RemoteAutomationHostAutomationHost_RetrieveById ( int automationHostId, )
Retrieves a single automation host by its id
RemoteAutomationHostAutomationHost_RetrieveByToken ( string?  token, )
Retrieves a single automation host by its token name
AutomationHost_Update ( RemoteAutomationHost?  remoteAutomationHost, )
Updates an automation host in the system
RemoteBuildBuild_Create ( RemoteBuild?  remoteBuild, )
Creates a new build in the system, including any linked source code revisions
RemoteBuildBuild_RetrieveById ( int releaseId, int buildId, )
Retrieves the a single build (and associated source code revisions) by its id
ArrayOfRemoteBuildBuild_RetrieveByReleaseId ( int releaseId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves the list of builds that are associated with a specific Release
RemoteComponentComponent_Create ( RemoteComponent?  remoteComponent, )
Creates a new component in the current project
Component_Delete ( int componentId, )
Deletes a component in the current project
ArrayOfRemoteComponentComponent_Retrieve ( boolean activeOnly, boolean includeDeleted, )
Retrieves a list of all the components in the current project
RemoteComponentComponent_RetrieveById ( int componentId, )
Retrieves a single component by its ID
Component_Undelete ( int componentId, )
Undeletes a component in the current project
Component_Update ( RemoteComponent?  remoteComponent, )
Updates an existing component in the current project
booleanConnection_Authenticate ( string?  userName, string?  password, )
Authenticates against the server. Need to call before using other methods
booleanConnection_Authenticate2 ( string?  userName, string?  password, string?  plugInName, )
Authenticates against the server. Need to call before using other methods. This overload allows you to specify the name of the plug-in calling the API
booleanConnection_Authenticate3 ( string?  userName, string?  apiKey, string?  plugInName, )
Authenticates against the server. Need to call before using other methods. This overload allows you to use the same API Key / RSS Token as the REST Service
booleanConnection_ConnectToProject ( int projectId, )
Connects to a project, needed before calling other artifact import methods
Connection_Disconnect
Disconnects the currenly authenticated / authorized user
RemoteCustomListCustomProperty_AddCustomList ( RemoteCustomList?  remoteCustomList, )
Adds a new custom list into the project
RemoteCustomListValueCustomProperty_AddCustomListValue ( RemoteCustomListValue?  remoteCustomListValue, )
Adds a new custom property list value into the system
RemoteCustomPropertyCustomProperty_AddDefinition ( RemoteCustomProperty?  remoteCustomProperty, int?  customListId, )
Adds a new custom property definition to the project for the specified artifact type
CustomProperty_DeleteDefinition ( int customPropertyId, )
Deletes a custom property definition from the system, including any associated options
RemoteCustomListCustomProperty_RetrieveCustomListById ( int customListId, )
Retrieves a custom list by its ID, including any custom list values
ArrayOfRemoteCustomListCustomProperty_RetrieveCustomLists
Retrieves all the custom lists in the current project
ArrayOfRemoteCustomPropertyCustomProperty_RetrieveForArtifactType ( int artifactTypeId, boolean includeDeleted, )
Retrieves the list of custom properties configured for the current project and the specified artifact type
CustomProperty_UpdateCustomList ( RemoteCustomList?  remoteCustomList, )
Updates a custom list and any associated values in the system
CustomProperty_UpdateDefinition ( RemoteCustomProperty?  remoteCustomProperty, )
Updates a custom property definition, including any associated options
DataMapping_AddArtifactMappings ( int dataSyncSystemId, int artifactTypeId, ArrayOfRemoteDataMapping?  remoteDataMappings, )
Adds new artifact data mapping entries
DataMapping_AddUserMappings ( int dataSyncSystemId, ArrayOfRemoteDataMapping?  remoteDataMappings, )
Adds new user data mapping entries
DataMapping_RemoveArtifactMappings ( int dataSyncSystemId, int artifactTypeId, ArrayOfRemoteDataMapping?  remoteDataMappings, )
Removes existing artifact data mapping entries
ArrayOfRemoteDataMappingDataMapping_RetrieveArtifactMappings ( int dataSyncSystemId, int artifactTypeId, )
Retrieves a list of data mappings for artifact ids in the system
RemoteDataMappingDataMapping_RetrieveCustomPropertyMapping ( int dataSyncSystemId, int artifactTypeId, int customPropertyId, )
Retrieves the data mapping for a custom property
ArrayOfRemoteDataMappingDataMapping_RetrieveCustomPropertyValueMappings ( int dataSyncSystemId, int artifactTypeId, int customPropertyId, )
Retrieves a list of data mappings for custom property values
ArrayOfRemoteDataMappingDataMapping_RetrieveFieldValueMappings ( int dataSyncSystemId, int artifactFieldId, )
Retrieves a list of data mappings for artifact field values
ArrayOfRemoteDataMappingDataMapping_RetrieveProjectMappings ( int dataSyncSystemId, )
Retrieves a list of data mappings for projects in the system
ArrayOfRemoteDataMappingDataMapping_RetrieveUserMappings ( int dataSyncSystemId, )
Retrieves a list of data mappings for users in the system
ArrayOfRemoteProjectArtifactDataMapping_SearchArtifactMappings ( int dataSyncSystemId, int artifactTypeId, string?  externalKey, )
Retrieves a list of data mappings for a specific artifact across all projects in the system
RemoteDataSyncSystemDataSyncSystem_Create ( RemoteDataSyncSystem?  remoteDataSyncSystem, )
Creates a new data sync system entry
ArrayOfRemoteDataSyncSystemDataSyncSystem_Retrieve
Retrieves a list of data-sync plug-ins that need to be synchronized with
RemoteDataSyncSystemDataSyncSystem_RetrieveById ( int dataSyncSystemId, )
Retrieves a single data sync system by its ID
DataSyncSystem_SaveRunFailure ( int dataSyncSystemId, )
Updates the status for a failed data-sync plug-in
DataSyncSystem_SaveRunSuccess ( int dataSyncSystemId, dateTime lastRunDate, )
Updates the status for a successful data-sync plug-in
DataSyncSystem_SaveRunWarning ( int dataSyncSystemId, dateTime lastRunDate, )
Updates the status for a data-sync plug-in that executed with warnings
DataSyncSystem_Update ( RemoteDataSyncSystem?  remoteDataSyncSystem, )
Updates an existing data sync system entry
DataSyncSystem_WriteEvent ( string?  message, string?  details, int eventLogEntryType, )
Writes an error/warning event entry to the SpiraTeam database log
RemoteDocumentDocument_AddFile ( RemoteDocument?  remoteDocument, base64Binary?  binaryData, )
Adds a new document (file) into the system and associates it with the provided artifact (optional) and project folder/type (optional)
RemoteDocumentVersionDocument_AddFileVersion ( RemoteDocumentVersion?  remoteDocumentVersion, base64Binary?  binaryData, boolean makeCurrent, )
Adds a new version to a file attachment in the system
RemoteDocumentFolderDocument_AddFolder ( RemoteDocumentFolder?  remoteDocumentFolder, )
Adds a new document folder into the current project
Document_AddToArtifactId ( int artifactTypeId, int artifactId, int attachmentId, )
Adds an existing attachment to the specified artifact.
RemoteDocumentDocument_AddUrl ( RemoteDocument?  remoteDocument, )
Adds a new document (url) into the system and associates it with the provided artifact (optional) and project folder/type (optional)
RemoteDocumentVersionDocument_AddUrlVersion ( RemoteDocumentVersion?  remoteDocumentVersion, boolean makeCurrent, )
Adds a new version to a URL attachment in the system
Document_Delete ( int attachmentId, )
Deletes an attachment from the project completely
Document_DeleteFolder ( int projectAttachmentFolderId, )
Deletes an existing document folder from the current project
Document_DeleteFromArtifact ( int attachmentId, int artifactTypeId, int artifactId, )
Deletes an attachment from an artifact. The attachment will still remain in the project
base64BinaryDocument_OpenFile ( int attachmentId, )
Returns the actual binary content of a file attachment in the system
ArrayOfRemoteDocumentDocument_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberRows, )
Retrieves a filtered list of documents/attachments in a project across all folders
RemoteDocumentDocument_RetrieveById ( int attachmentId, )
Retrieves a single project document by its id
RemoteDocumentFolderDocument_RetrieveFolderById ( int folderId, )
Retrieves the folder by the specified ID.
ArrayOfRemoteDocumentFolderDocument_RetrieveFolders
Retrieves a list of all the document folders in the current project
ArrayOfRemoteDocumentDocument_RetrieveForArtifact ( int artifactTypeId, int artifactId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, )
Retrieves a filtered list of documents/attachments in a project attached to a specific artifact
ArrayOfRemoteDocumentDocument_RetrieveForFolder ( int folderId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberRows, )
Retrieves a filtered list of documents/attachments in a project for the specified folder
ArrayOfRemoteDocumentTypeDocument_RetrieveTypes ( boolean activeOnly, )
Retrieves a list of all the document types in the current project
Document_UpdateFolder ( RemoteDocumentFolder?  remoteDocumentFolder, )
Updates the name and position of an existing folder in the project
RemoteHistoryChangeSetHistory_RetrieveById ( int historyChangeSetId, )
Retrieves the details of a specific change made
ArrayOfRemoteHistoryChangeHistory_RetrieveForArtifact ( int artifactTypeId, int artifactId, int startingRow, int numberOfRows, RemoteSort?  remoteSort, ArrayOfRemoteFilter?  remoteFilters, )
Retrieves the history of changes for a specific artifact
ArrayOfRemoteCommentIncident_AddComments ( ArrayOfRemoteComment?  remoteComments, )
Adds new incident comments to incidents in the system
RemoteIncidentPriorityIncident_AddPriority ( RemoteIncidentPriority?  remoteIncidentPriority, )
Adds a new incident priority to the current project
RemoteIncidentSeverityIncident_AddSeverity ( RemoteIncidentSeverity?  remoteIncidentSeverity, )
Adds a new incident severity to the current project
RemoteIncidentStatusIncident_AddStatus ( RemoteIncidentStatus?  remoteIncidentStatus, )
Adds a new incident status to the current project
RemoteIncidentTypeIncident_AddType ( RemoteIncidentType?  remoteIncidentType, )
Adds a new incident type to the current project
longIncident_Count ( ArrayOfRemoteFilter?  remoteFilters, )
Returns the number of incidents that match the filter.
RemoteIncidentIncident_Create ( RemoteIncident?  remoteIncident, )
Creates a new incident in the system
Incident_Delete ( int incidentId, )
Deletes a incident in the system
ArrayOfRemoteIncidentIncident_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of incidents in the system that match the provided filter/sort
RemoteIncidentIncident_RetrieveById ( int incidentId, )
Retrieves a single incident in the system
ArrayOfRemoteIncidentIncident_RetrieveByTestCase ( int testCaseId, boolean openOnly, )
Retrieves a list of incidents in the system that are linked to a specific test case (either through test runs or test steps)
ArrayOfRemoteIncidentIncident_RetrieveByTestRunStep ( int testRunStepId, )
Retrieves a list of incidents in the system that are linked to a specific test run step
ArrayOfRemoteIncidentIncident_RetrieveByTestStep ( int testStepId, )
Retrieves a list of incidents in the system that are linked to a specific test step (either directly or indirectly through test runs)
ArrayOfRemoteCommentIncident_RetrieveComments ( int incidentId, )
Retrieves the incident resolutions for an incident
RemoteIncidentStatusIncident_RetrieveDefaultStatus
Retrieves the default incident status for the current project
RemoteIncidentTypeIncident_RetrieveDefaultType
Retrieves the default incident type for the current project
ArrayOfRemoteIncidentIncident_RetrieveForOwner
Retrieves all open incidents owned by the currently authenticated user
ArrayOfRemoteIncidentIncident_RetrieveNew ( dateTime creationDate, int startRow, int numberOfRows, )
Retrieves all new incidents added in the system since the date specified
ArrayOfRemoteIncidentPriorityIncident_RetrievePriorities
Retrieves a list of the active incident priorities for the current project
ArrayOfRemoteIncidentSeverityIncident_RetrieveSeverities
Retrieves a list of the active incident severities for the current project
ArrayOfRemoteIncidentStatusIncident_RetrieveStatuses
Retrieves a list of the active incident statuses for the current project
ArrayOfRemoteIncidentTypeIncident_RetrieveTypes
Retrieves a list of the active incident types for the current project
ArrayOfRemoteWorkflowCustomPropertyIncident_RetrieveWorkflowCustomProperties ( int currentTypeId, int currentStatusId, )
Retrieves the list of incident custom properties and their workflow state for a given type and status/step.
ArrayOfRemoteWorkflowFieldIncident_RetrieveWorkflowFields ( int currentTypeId, int currentStatusId, )
Retrieves the list of incident fields and their workflow status for a given type and status/step.
ArrayOfRemoteWorkflowTransitionIncident_RetrieveWorkflowTransitions ( int currentTypeId, int currentStatusId, boolean isDetector, boolean isOwner, )
Will retrieve available transitions for the specied status ID for the currently logged-on user.
Incident_Update ( RemoteIncident?  remoteIncident, )
Updates an incident in the system
RemoteMessageInfoMessage_GetInfo
Retrieves the IM status for the current user
ArrayOfRemoteUserMessageMessage_GetUnreadMessageSenders
Gets the list of users and number of unread messages from them
Message_MarkAllAsRead ( int senderUserId, )
Marks all the messages as read for a specific sending user
longMessage_PostNew ( int recipientUserId, string?  message, )
Posts a new message to a specific recipient
ArrayOfRemoteMessageMessage_RetrieveUnread
Retrieves the list of unread messages
Project_AddUserMembership ( RemoteProjectUser?  remoteProjectUser, )
Adds users to a project with a specific role
RemoteProjectProject_Create ( RemoteProject?  remoteProject, int?  existingProjectId, )
Creates a new project in the system and makes the authenticated user owner of it
Project_Delete ( int projectId, )
Deletes an existing project in the system
Project_RefreshProgressExecutionStatusCaches ( int?  releaseId, boolean runInBackground, )
Refreshes the task progress and test execution status for a project. Typically this needs to be called after TestRun_RecordAutomated3(...) API calls to ensure the data in the system is consistent
ArrayOfRemoteProjectProject_Retrieve
Retrieves a list of projects that the authenticated user has access to
RemoteProjectProject_RetrieveById ( int projectId, )
Retrieves a single project in the system
ArrayOfRemoteProjectUserProject_RetrieveUserMembership
Retrieves the list of users that are members of the current project
Project_UpdateUserMembership ( RemoteProjectUser?  remoteProjectUser, )
Updates the user's role on a specific project
ArrayOfRemoteProjectRoleProjectRole_Retrieve
Retrieves a list of project roles in the system
Release_AddTestMapping ( RemoteReleaseTestCaseMapping?  remoteReleaseTestCaseMapping, )
Maps a release to a test case, so that the test case is needs to be tested for that release
Release_AddTestMapping2 ( ArrayOfRemoteReleaseTestCaseMapping?  remoteReleaseTestCaseMappings, )
Maps a release to a test case, so that the test case is needs to be tested for that release
longRelease_Count ( ArrayOfRemoteFilter?  remoteFilters, )
Returns the number of releases that match the filter.
RemoteReleaseRelease_Create ( RemoteRelease?  remoteRelease, int?  parentReleaseId, )
Creates a new release in the system
RemoteCommentRelease_CreateComment ( RemoteComment?  remoteComment, )
Creates a new comment for a release.
Release_Delete ( int releaseId, )
Deletes a release in the system
Release_Indent ( int releaseId, )
Indents a release one position
Release_Move ( int releaseId, int?  destinationReleaseId, )
Moves a release to another location in the hierarchy
Release_Outdent ( int releaseId, )
Outdents a release one position
Release_RemoveTestMapping ( RemoteReleaseTestCaseMapping?  remoteReleaseTestCaseMapping, )
Removes a mapping entry for a specific release and test case
ArrayOfRemoteReleaseRelease_Retrieve ( boolean activeOnly, )
Retrieves all the releases and iterations belonging to the current project
ArrayOfRemoteReleaseRelease_Retrieve2 ( ArrayOfRemoteFilter?  remoteFilters, int startingRow, int numberOfRows, )
Retrieves a list of releases in the system that match the provided filter
RemoteReleaseRelease_RetrieveById ( int releaseId, )
Retrieves a single release in the system
ArrayOfRemoteCommentRelease_RetrieveComments ( int ReleaseId, )
Retrieves comments for a specified release.
ArrayOfRemoteReleaseStatusRelease_RetrieveStatuses
Retrieves the list of release statuses in the system
ArrayOfRemoteReleaseTestCaseMappingRelease_RetrieveTestMapping ( int releaseId, )
Retrieves the mapped test cases for a specific release
ArrayOfRemoteReleaseTypeRelease_RetrieveTypes
Retrieves the list of release types in the system
ArrayOfRemoteWorkflowCustomPropertyRelease_RetrieveWorkflowCustomProperties ( int currentTypeId, int currentStatusId, )
Retrieves the list of release custom properties and their workflow state for a given type and status/step.
ArrayOfRemoteWorkflowFieldRelease_RetrieveWorkflowFields ( int currentTypeId, int currentStatusId, )
Retrieves the list of release fields and their workflow status for a given type and status/step.
ArrayOfRemoteWorkflowTransitionRelease_RetrieveWorkflowTransitions ( int currentTypeId, int currentStatusId, boolean isCreator, boolean isOwner, )
Will retrieve available transitions for the specied status ID for the currently logged-on user.
Release_Update ( RemoteRelease?  remoteRelease, )
Updates a release in the system
RemoteRequirementStepRequirement_AddStep ( RemoteRequirementStep?  remoteRequirementStep, int?  existingRequirementStepId, int?  creatorId, )
Adds a requirement step to a requirement
Requirement_AddTestCoverage ( RemoteRequirementTestCaseMapping?  remoteReqTestCaseMapping, )
Maps a requirement to a test case, so that the test case 'covers' the requirement
longRequirement_Count ( ArrayOfRemoteFilter?  remoteFilters, )
Returns the number of requirements that match the filter.
RemoteRequirementRequirement_Create1 ( RemoteRequirement?  remoteRequirement, int indentPosition, )
Creates a new requirement record in the current project using the position offset method
RemoteRequirementRequirement_Create2 ( RemoteRequirement?  remoteRequirement, int?  parentRequirementId, )
Creates a new requirement in the system
RemoteCommentRequirement_CreateComment ( RemoteComment?  remoteComment, )
Creates a new comment for a requirement.
Requirement_Delete ( int requirementId, )
Deletes a requirement in the system
Requirement_DeleteStep ( int requirementId, int requirementStepId, )
Deletes a requirement step in the list
Requirement_Indent ( int requirementId, )
Indents a requirement one position
Requirement_Move ( int requirementId, int?  destinationRequirementId, )
Moves a requirement to another location in the hierarchy
Requirement_MoveStep ( int requirementId, int sourceRequirementStepId, int?  destinationRequirementStepId, )
Moves a requirement step in the list
Requirement_Outdent ( int requirementId, )
Outdents a requirement one position
Requirement_RemoveTestCoverage ( RemoteRequirementTestCaseMapping?  remoteReqTestCaseMapping, )
Removes a coverage mapping entry for a specific requirement and test case
ArrayOfRemoteRequirementRequirement_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, int startingRow, int numberOfRows, )
Retrieves a list of requirements in the system that match the provided filter
RemoteRequirementRequirement_RetrieveById ( int requirementId, )
Retrieves a single requirement in the system
ArrayOfRemoteCommentRequirement_RetrieveComments ( int RequirementId, )
Retrieves comments for a specified requirement.
ArrayOfRemoteRequirementRequirement_RetrieveForOwner
Retrieves all requirements owned by the currently authenticated user
ArrayOfRemoteRequirementStatusRequirement_RetrieveStatuses
Retrieves the list of requirement statuses in the system
RemoteRequirementStepRequirement_RetrieveStepById ( int requirementStepId, )
Retrieves a single requirement step by its ID
ArrayOfRemoteRequirementStepRequirement_RetrieveSteps ( int requirementId, )
Retrieves a list of requirement steps
ArrayOfRemoteRequirementTestCaseMappingRequirement_RetrieveTestCoverage ( int requirementId, )
Retrieves the test coverage for a specific requirement
ArrayOfRemoteRequirementTypeRequirement_RetrieveTypes
Retrieves the list of requirement types in the system
ArrayOfRemoteWorkflowCustomPropertyRequirement_RetrieveWorkflowCustomProperties ( int currentTypeId, int currentStatusId, )
Retrieves the list of requirement custom properties and their workflow state for a given type and status/step.
ArrayOfRemoteWorkflowFieldRequirement_RetrieveWorkflowFields ( int currentTypeId, int currentStatusId, )
Retrieves the list of requirement fields and their workflow status for a given type and status/step.
ArrayOfRemoteWorkflowTransitionRequirement_RetrieveWorkflowTransitions ( int currentTypeId, int currentStatusId, boolean isCreator, boolean isOwner, )
Will retrieve available transitions for the specied status ID for the currently logged-on user.
Requirement_Update ( RemoteRequirement?  remoteRequirement, )
Updates a requirement in the system
Requirement_UpdateStep ( RemoteRequirementStep?  remoteRequirementStep, )
Updates an existing requirement step
ArrayOfRemoteSavedFilterSavedFilter_RetrieveForUser
Retrieves the list of saved filters for the current user
base64BinarySourceCode_OpenFileById ( string?  branchId, string?  fileId, string?  revisionId, )
Returns the physical contents of a file in a linked source code repository
ArrayOfRemoteLinkedArtifactSourceCode_RetrieveArtifactsForRevision ( string?  branchId, string?  revisionId, )
Retrieves a list of artifacts associated with a specific revision
ArrayOfRemoteSourceCodeBranchSourceCode_RetrieveBranches
Retrieves a list of source code branches in the project
RemoteSourceCodeFileSourceCode_RetrieveFileById ( string?  branchId, string?  fileId, )
Retrieves a specific file by its ID
ArrayOfRemoteSourceCodeFileSourceCode_RetrieveFilesByFolder ( string?  branchId, string?  folderId, )
Retrieves a list of files in a specific folder
ArrayOfRemoteSourceCodeFileSourceCode_RetrieveFilesByRevision ( string?  branchId, string?  revisionId, )
Retrieves a list of files contained in a specific revision
ArrayOfRemoteSourceCodeFileSourceCode_RetrieveFilesForArtifact ( string?  branchId, int artifactTypeId, int artifactId, )
Retrieves a list of files associated with a specific artifact
ArrayOfRemoteSourceCodeFolderSourceCode_RetrieveFoldersByParent ( string?  branchId, string?  parentFolderId, )
Retrieves a list of folders by their parent (unless root)
RemoteSourceCodeRevisionSourceCode_RetrieveRevisionById ( string?  branchId, string?  revisionId, )
Retrieves a revision by its ID
ArrayOfRemoteSourceCodeRevisionSourceCode_RetrieveRevisions ( string?  branchId, int startRow, int numberRows, RemoteSort?  remoteSort, ArrayOfRemoteFilter?  remoteFilters, )
Retrieves a sorted, filtered, paginated list of revisions in the repository
ArrayOfRemoteSourceCodeRevisionSourceCode_RetrieveRevisionsForArtifact ( string?  branchId, int artifactTypeId, int artifactId, )
Retrieves a list of revisions associated with a specific artifact
ArrayOfRemoteSourceCodeRevisionSourceCode_RetrieveRevisionsForFile ( string?  branchId, string?  fileId, )
Retrieves a list of revisions for a specific file
ArrayOfRemoteArtifactSubscriptionSubscription_RetrieveForArtifact ( int artifactTypeId, int artifactId, )
Retrieves a list of all the users subscribed to an artifact
ArrayOfRemoteArtifactSubscriptionSubscription_RetrieveForUser
Retrieves a list of all the items the current user is subscribed to (all projects)
Subscription_SubscribeToArtifact ( int artifactTypeId, int artifactId, )
Subscribes to a specified artifact
Subscription_UnsubscribeFromArtifact ( int artifactTypeId, int artifactId, )
Unsubscribes from a specified artifact
stringSystem_GetArtifactUrl ( int navigationLinkId, int projectId, int artifactId, string?  tabName, )
Returns the application-relative URL to a particular artifact in the system
stringSystem_GetProductName
Gets the brand name of the product installed
RemoteVersionSystem_GetProductVersion
Retrieves the version number of the current installation.
intSystem_GetProjectIdForArtifact ( int artifactTypeId, int artifactId, )
Returns the project ID number that the queried artifact exists in.
dateTimeSystem_GetServerDateTime
Retrieves the current date-time on the server converted into UTC
ArrayOfRemoteSettingSystem_GetSettings
Returns the current configuration settings for the installation.
stringSystem_GetWebServerUrl
Gets the base URL of the website that the system is running under. Used for notifications and exported artifacts
longTask_Count ( ArrayOfRemoteFilter?  remoteFilters, )
Returns the number of tasks that match the filter.
RemoteTaskTask_Create ( RemoteTask?  remoteTask, )
Creates a new task in the system
RemoteCommentTask_CreateComment ( RemoteComment?  remoteComment, )
Creates a new comment for a task.
RemoteTaskFolderTask_CreateFolder ( RemoteTaskFolder?  remoteTaskFolder, )
Creates a new task folder in the system
Task_Delete ( int taskId, )
Deletes a task in the system
Task_DeleteFolder ( int taskFolderId, )
Deletes a task folder in the system
ArrayOfRemoteTaskTask_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of tasks in the system that match the provided filter/sort
RemoteTaskTask_RetrieveById ( int taskId, )
Retrieves a single task in the system
ArrayOfRemoteCommentTask_RetrieveComments ( int TaskId, )
Retrieves comments for a specified task.
RemoteTaskFolderTask_RetrieveFolderById ( int taskFolderId, )
Retrieves a single test folder in the system
ArrayOfRemoteTaskFolderTask_RetrieveFolders
Retrieves all of the task folders in the project with their hierarchy
ArrayOfRemoteTaskFolderTask_RetrieveFoldersByParent ( int?  parentTaskFolderId, )
Retrieves a list of folders by the parent folder
ArrayOfRemoteTaskTask_RetrieveForOwner
Retrieves all tasks owned by the currently authenticated user
ArrayOfRemoteTaskTask_RetrieveNew ( dateTime creationDate, int startRow, int numberOfRows, )
Retrieves all new tasks added in the system since the date specified
ArrayOfRemoteTaskStatusTask_RetrieveStatuses
Retrieves the list of task statuses in the system
ArrayOfRemoteTaskTypeTask_RetrieveTypes
Retrieves the list of task types in the system
ArrayOfRemoteWorkflowCustomPropertyTask_RetrieveWorkflowCustomProperties ( int currentTypeId, int currentStatusId, )
Retrieves the list of task custom properties and their workflow state for a given type and status/step.
ArrayOfRemoteWorkflowFieldTask_RetrieveWorkflowFields ( int currentTypeId, int currentStatusId, )
Retrieves the list of task fields and their workflow status for a given type and status/step.
ArrayOfRemoteWorkflowTransitionTask_RetrieveWorkflowTransitions ( int currentTypeId, int currentStatusId, boolean isCreator, boolean isOwner, )
Will retrieve available transitions for the specied status ID for the currently logged-on user.
Task_Update ( RemoteTask?  remoteTask, )
Updates a task in the system
Task_UpdateFolder ( RemoteTaskFolder?  remoteTaskFolder, )
Updates a test folder in the system
intTestCase_AddLink ( int testCaseId, int position, int linkedTestCaseId, ArrayOfRemoteTestStepParameter?  parameters, )
Adds a new test step that is actually a link to a test case
RemoteTestCaseParameterTestCase_AddParameter ( RemoteTestCaseParameter?  remoteTestCaseParameter, )
Adds a new parameter for a test case
RemoteTestStepTestCase_AddStep ( RemoteTestStep?  remoteTestStep, int testCaseId, )
Adds a new test step to the specified test case
TestCase_AddUpdateAutomationScript ( int testCaseId, int?  automationEngineId, string?  urlOrFilename, string?  description, base64Binary?  binaryData, string?  version, int?  projectAttachmentTypeId, int?  projectAttachmentFolderId, )
Adds or updates the automation test script associated with a test case
longTestCase_Count ( ArrayOfRemoteFilter?  remoteFilters, int?  releaseId, )
Returns the number of test cases that match the filter.
longTestCase_CountForFolder ( int?  testCaseFolderId, ArrayOfRemoteFilter?  remoteFilters, int?  releaseId, )
Gives a count of items within the given folder that match the filters.
RemoteTestCaseTestCase_Create ( RemoteTestCase?  remoteTestCase, )
Creates a new test case in the system
RemoteCommentTestCase_CreateComment ( RemoteComment?  remoteComment, )
Creates a new comment for a test case.
RemoteTestCaseFolderTestCase_CreateFolder ( RemoteTestCaseFolder?  remoteTestCaseFolder, )
Creates a new test case folder in the system
stringTestCase_CreateParameterToken ( string?  parameterName, )
Returns the full token of a test case parameter from its name
TestCase_Delete ( int testCaseId, )
Deletes a test case in the system
TestCase_DeleteFolder ( int testCaseFolderId, )
Deletes a test case folder in the system
TestCase_DeleteStep ( int testCaseId, int testStepId, )
Deletes a test step in the system
TestCase_Move ( int testCaseId, int?  testCaseFolderId, )
Moves a test case to another location in the hierarchy
TestCase_MoveStep ( int testCaseId, int sourceTestStepId, int?  destinationTestStepId, )
Moves a test step to a different position in the test case
ArrayOfRemoteTestCaseTestCase_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, int?  releaseId, )
Retrieves a list of testCases in the project (all folders) that match the provided filter
ArrayOfRemoteTestCaseTestCase_RetrieveByFolder ( int?  testCaseFolderId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, int?  releaseId, )
Retrieves a list of testCases in the project (all folders) that match the provided filter
RemoteTestCaseTestCase_RetrieveById ( int testCaseId, )
Retrieves a single test case in the system
ArrayOfRemoteTestCaseTestCase_RetrieveByTestSetId ( int testSetId, )
Retrieves all the test cases that are part of a test set
ArrayOfRemoteCommentTestCase_RetrieveComments ( int TestCaseId, )
Retrieves comments for a specified test case.
RemoteTestCaseFolderTestCase_RetrieveFolderById ( int testCaseFolderId, )
Retrieves a single test folder in the system
ArrayOfRemoteTestCaseFolderTestCase_RetrieveFolders
Retrieves all of the test case folders in the project with their hierarchy
ArrayOfRemoteTestCaseFolderTestCase_RetrieveFoldersByParent ( int?  parentTestCaseFolderId, int?  releaseId, )
Retrieves a list of folders by the parent folder
ArrayOfRemoteTestCaseTestCase_RetrieveForOwner
Retrieves all testCases owned by the currently authenticated user
ArrayOfRemoteTestCaseParameterTestCase_RetrieveParameters ( int testCaseId, )
Retrieves the list of defined parameters for a test case along with the associated default value
ArrayOfRemoteTestCaseStatusTestCase_RetrieveStatuses
Retrieves the list of testCase statuses in the system
RemoteTestStepTestCase_RetrieveStepById ( int testStepId, )
Retrieves a single test step by its ID
ArrayOfRemoteTestStepParameterTestCase_RetrieveStepParameters ( int testCaseId, int testStepId, )
Retrieves the list of parameters and provided values for a test link step
ArrayOfRemoteTestStepTestCase_RetrieveSteps ( int testCaseId, )
Retrieves the list of test steps for a test case
ArrayOfRemoteTestCaseTypeTestCase_RetrieveTypes
Retrieves the list of testCase types in the system
ArrayOfRemoteWorkflowCustomPropertyTestCase_RetrieveWorkflowCustomProperties ( int currentTypeId, int currentStatusId, )
Retrieves the list of testCase custom properties and their workflow state for a given type and status/step.
ArrayOfRemoteWorkflowFieldTestCase_RetrieveWorkflowFields ( int currentTypeId, int currentStatusId, )
Retrieves the list of testCase fields and their workflow status for a given type and status/step.
ArrayOfRemoteWorkflowTransitionTestCase_RetrieveWorkflowTransitions ( int currentTypeId, int currentStatusId, boolean isCreator, boolean isOwner, )
Will retrieve available transitions for the specied status ID for the currently logged-on user.
TestCase_Update ( RemoteTestCase?  remoteTestCase, )
Updates a test case in the system together with its test steps (if populated)
TestCase_UpdateFolder ( RemoteTestCaseFolder?  remoteTestCaseFolder, )
Updates a test folder in the system
TestCase_UpdateStep ( RemoteTestStep?  remoteTestStep, )
Updates a single test step in the system
longTestRun_Count ( ArrayOfRemoteFilter?  remoteFilters, )
Returns the number of test runs that match the filter.
ArrayOfRemoteAutomatedTestRunTestRun_CreateForAutomatedTestSet ( int testSetId, string?  automationHostToken, )
Creates a shell set of test runs for an external automated test runner based on the provided test set id
ArrayOfRemoteAutomatedTestRunTestRun_CreateForAutomationHost ( string?  automationHostToken, DateRange?  dateRange, )
Creates a shell set of test runs for an external automated test runner based on the provided automation host token and the specified date range
ArrayOfRemoteManualTestRunTestRun_CreateFromTestCases ( ArrayOfint?  testCaseIds, int?  releaseId, )
Creates a new test run shell from the provided test case(s)
ArrayOfRemoteManualTestRunTestRun_CreateFromTestSet ( int testSetId, )
Creates a new test run shell from the provided test set
TestRun_Delete ( int testRunId, )
Deletes a test run from the system
RemoteAutomatedTestRunTestRun_RecordAutomated1 ( RemoteAutomatedTestRun?  remoteTestRun, )
Records the results of executing an automated test
intTestRun_RecordAutomated2 ( string?  userName, string?  password, int projectId, int?  testerUserId, int testCaseId, int?  releaseId, int?  testSetId, int?  testSetTestCaseId, int?  buildId, dateTime startDate, dateTime endDate, int executionStatusId, string?  runnerName, string?  runnerTestName, int runnerAssertCount, string?  runnerMessage, string?  runnerStackTrace, int testRunFormatId, )
Records the results of executing an automated test
ArrayOfRemoteAutomatedTestRunTestRun_RecordAutomated3 ( ArrayOfRemoteAutomatedTestRun?  remoteTestRuns, )
Records the results of executing multiple automated tests
ArrayOfRemoteTestRunTestRun_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of test runs in the system that match the provided filter/sort
ArrayOfRemoteAutomatedTestRunTestRun_RetrieveAutomated ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of automated test runs in the system that match the provided filter/sort
RemoteAutomatedTestRunTestRun_RetrieveAutomatedById ( int testRunId, )
Retrieves a single automated test run in the system including the automation-specific information
RemoteTestRunTestRun_RetrieveById ( int testRunId, )
Retrieves a single test run in the system. Only returns the generic information that is applicable for both automated and manual tests. Consider using TestRun_RetrieveAutomatedById or TestRun_RetrieveManualById if you need the automation/manual specific data for the test run
ArrayOfRemoteTestRunTestRun_RetrieveByTestCaseId ( int testCaseId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of test runs for a specific test case
ArrayOfRemoteManualTestRunTestRun_RetrieveManual ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, )
Retrieves a list of manual test runs in the system that match the provided filter/sort
RemoteManualTestRunTestRun_RetrieveManualById ( int testRunId, )
Retrieves a single manual test run in the system including any associated steps
ArrayOfRemoteManualTestRunTestRun_Save ( ArrayOfRemoteManualTestRun?  remoteTestRuns, dateTime?  endDate, )
Saves set of test runs, each containing test run steps
ArrayOfRemoteTestSetTestCaseMappingTestSet_AddTestMapping ( RemoteTestSetTestCaseMapping?  remoteTestSetTestCaseMapping, int?  existingTestSetTestCaseId, ArrayOfRemoteTestSetTestCaseParameter?  parameters, )
Maps a test set to a test case, so that the test case is part of the test set
longTestSet_Count ( ArrayOfRemoteFilter?  remoteFilters, int?  releaseId, )
Returns the number of test sets that match the filter.
longTestSet_CountForFolder ( int?  testSetFolderId, ArrayOfRemoteFilter?  remoteFilters, int?  releaseId, )
Gives a count of items within the given folder that match the filters.
RemoteTestSetTestSet_Create ( RemoteTestSet?  remoteTestSet, )
Creates a new test set in the system
RemoteCommentTestSet_CreateComment ( RemoteComment?  remoteComment, )
Creates a new comment for a test set.
RemoteTestSetFolderTestSet_CreateFolder ( RemoteTestSetFolder?  remoteTestSetFolder, )
Creates a new test set folder in the system
TestSet_Delete ( int testSetId, )
Deletes a test set / folder in the system
TestSet_DeleteFolder ( int testSetFolderId, )
Deletes a test set folder in the system
TestSet_Move ( int testSetId, int?  destinationTestSetId, )
Moves a test set to another location in the hierarchy
TestSet_RemoveTestMapping ( RemoteTestSetTestCaseMapping?  remoteTestSetTestCaseMapping, )
Removes a test case from a test set
ArrayOfRemoteTestSetTestSet_Retrieve ( ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, int?  releaseId, )
Retrieves a list of testSets in the project (all folders) that match the provided filter
ArrayOfRemoteTestSetTestSet_RetrieveByFolder ( int?  testSetFolderId, ArrayOfRemoteFilter?  remoteFilters, RemoteSort?  remoteSort, int startingRow, int numberOfRows, int?  releaseId, )
Retrieves a list of testSets in the project (all folders) that match the provided filter
RemoteTestSetTestSet_RetrieveById ( int testSetId, )
Retrieves a single test set/folder in the system
ArrayOfRemoteCommentTestSet_RetrieveComments ( int TestSetId, )
Retrieves comments for a specified test set.
RemoteTestSetFolderTestSet_RetrieveFolderById ( int testSetFolderId, )
Retrieves a single test folder in the system
ArrayOfRemoteTestSetFolderTestSet_RetrieveFolders
Retrieves all of the test set folders in the project with their hierarchy
ArrayOfRemoteTestSetFolderTestSet_RetrieveFoldersByParent ( int?  parentTestSetFolderId, int?  releaseId, )
Retrieves a list of folders by the parent folder
ArrayOfRemoteTestSetTestSet_RetrieveForOwner
Retrieves all testSets owned by the currently authenticated user
ArrayOfRemoteTestSetParameterTestSet_RetrieveParameters ( int testSetId, )
Retrieves a list of test parameter values specified by a specific test set
ArrayOfRemoteTestSetTestCaseMappingTestSet_RetrieveTestCaseMapping ( int testSetId, )
Retrieves all the test cases that are part of a test set
ArrayOfRemoteTestSetTestCaseParameterTestSet_RetrieveTestCaseParameters ( int testSetId, int testSetTestCaseId, )
Retrieves a list of test parameter values specified by a specific test set's test case instance
TestSet_Update ( RemoteTestSet?  remoteTestSet, )
Updates a test set in the system
TestSet_UpdateFolder ( RemoteTestSetFolder?  remoteTestSetFolder, )
Updates a test folder in the system
User_AddContact ( int userId, )
Adds a user as a contact
RemoteUserUser_Create ( RemoteUser?  remoteUser, string?  password, string?  passwordQuestion, string?  passwordAnswer, int?  projectRoleId, )
Creates a new user in the system and adds them to the current project as the specified role
User_Delete ( int userId, )
Tries to delete the specified user ID. Note that this function will fail if any other foreign keys (fields) in other tables are assigned to the user that is specified.) Must be connected to the API as the root Administrator.
User_RemoveContact ( int userId, )
Removes a user as a contact
ArrayOfRemoteUserUser_Retrieve
Retrieves a list of all the active users in the system (all projects)
RemoteUserUser_RetrieveById ( int userId, )
Retrieves a single user in the system
RemoteUserUser_RetrieveByUserName ( string?  userName, boolean includeInactive, )
Retrieves a single user in the system by user-name
ArrayOfRemoteUserUser_RetrieveContacts
Retrieves the list of contacts for the current user
User_Update ( RemoteUser?  remoteUser, )
Updates an existing user in the system