SpiraPlan: ImportExport SOAP Web Service (v4.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 v4.0 or greater. There are older APIs available for older versions of the system (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 |
|---|---|
| RemoteAssociation | Association_Create ( RemoteAssociation?
remoteAssociation,
) Adds a new association in the system |
| ArrayOfRemoteAssociation | Association_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 | |
| RemoteAutomationEngine | AutomationEngine_Create ( RemoteAutomationEngine?
remoteEngine,
) Creates a new Automation Engine in the system. |
| ArrayOfRemoteAutomationEngine | AutomationEngine_Retrieve ( boolean activeOnly,
) Retrieves the list of automation engines in the system |
| RemoteAutomationEngine | AutomationEngine_RetrieveById ( int automationEngineId,
) Retrieves a single automation engine record by its ID |
| RemoteAutomationEngine | AutomationEngine_RetrieveByToken ( string?
token,
) Retrieves a single automation engine record by its Token |
| RemoteAutomationHost | AutomationHost_Create ( RemoteAutomationHost?
remoteAutomationHost,
) Creates a new automation host in the system |
| AutomationHost_Delete ( int automationHostId,
) Deletes a automation host in the system | |
| ArrayOfRemoteAutomationHost | AutomationHost_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves the list of automation hosts in the current project |
| RemoteAutomationHost | AutomationHost_RetrieveById ( int automationHostId,
) Retrieves a single automation host by its id |
| RemoteAutomationHost | AutomationHost_RetrieveByToken ( string?
token,
) Retrieves a single automation host by its token name |
| AutomationHost_Update ( RemoteAutomationHost?
remoteAutomationHost,
) Updates an automation host in the system | |
| RemoteBuild | Build_Create ( RemoteBuild?
remoteBuild,
) Creates a new build in the system, including any linked source code revisions |
| RemoteBuild | Build_RetrieveById ( int releaseId,
int buildId,
) Retrieves the a single build (and associated source code revisions) by its id |
| ArrayOfRemoteBuild | Build_RetrieveByReleaseId ( int releaseId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves the list of builds that are associated with a specific Release |
| boolean | Connection_Authenticate ( string?
userName,
string?
password,
) Authenticates against the server. Need to call before using other methods |
| boolean | Connection_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 |
| boolean | Connection_ConnectToProject ( int projectId,
) Connects to a project, needed before calling other artifact import methods |
| Connection_Disconnect Disconnects the currenly authenticated / authorized user | |
| RemoteCustomList | CustomProperty_AddCustomList ( RemoteCustomList?
remoteCustomList,
) Adds a new custom list into the project |
| RemoteCustomListValue | CustomProperty_AddCustomListValue ( RemoteCustomListValue?
remoteCustomListValue,
) Adds a new custom property list value into the system |
| RemoteCustomProperty | CustomProperty_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 | |
| RemoteCustomList | CustomProperty_RetrieveCustomListById ( int customListId,
) Retrieves a custom list by its ID, including any custom list values |
| ArrayOfRemoteCustomList | CustomProperty_RetrieveCustomLists Retrieves all the custom lists in the current project |
| ArrayOfRemoteCustomProperty | CustomProperty_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 | |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveArtifactMappings ( int dataSyncSystemId,
int artifactTypeId,
) Retrieves a list of data mappings for artifact ids in the system |
| RemoteDataMapping | DataMapping_RetrieveCustomPropertyMapping ( int dataSyncSystemId,
int artifactTypeId,
int customPropertyId,
) Retrieves the data mapping for a custom property |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveCustomPropertyValueMappings ( int dataSyncSystemId,
int artifactTypeId,
int customPropertyId,
) Retrieves a list of data mappings for custom property values |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveFieldValueMappings ( int dataSyncSystemId,
int artifactFieldId,
) Retrieves a list of data mappings for artifact field values |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveProjectMappings ( int dataSyncSystemId,
) Retrieves a list of data mappings for projects in the system |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveUserMappings ( int dataSyncSystemId,
) Retrieves a list of data mappings for users in the system |
| RemoteDocument | Document_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) |
| RemoteDocumentVersion | Document_AddFileVersion ( RemoteDocumentVersion?
remoteDocumentVersion,
base64Binary?
binaryData,
boolean makeCurrent,
) Adds a new version to a file attachment in the system |
| RemoteDocumentFolder | Document_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. | |
| RemoteDocument | Document_AddUrl ( RemoteDocument?
remoteDocument,
) Adds a new document (url) into the system and associates it with the provided artifact (optional) and project folder/type (optional) |
| RemoteDocumentVersion | Document_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 | |
| base64Binary | Document_OpenFile ( int attachmentId,
) Returns the actual binary content of a file attachment in the system |
| ArrayOfRemoteDocument | Document_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberRows,
) Retrieves a filtered list of documents/attachments in a project across all folders |
| RemoteDocument | Document_RetrieveById ( int attachmentId,
) Retrieves a single project document by its id |
| RemoteDocumentFolder | Document_RetrieveFolderById ( int folderId,
) Retrieves the folder by the specified ID. |
| ArrayOfRemoteDocumentFolder | Document_RetrieveFolders Retrieves a list of all the document folders in the current project |
| ArrayOfRemoteDocument | Document_RetrieveForArtifact ( int artifactTypeId,
int artifactId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
) Retrieves a filtered list of documents/attachments in a project attached to a specific artifact |
| ArrayOfRemoteDocument | Document_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 |
| ArrayOfRemoteDocumentType | Document_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 | |
| ArrayOfRemoteComment | Incident_AddComments ( ArrayOfRemoteComment?
remoteComments,
) Adds new incident comments to incidents in the system |
| RemoteIncidentPriority | Incident_AddPriority ( RemoteIncidentPriority?
remoteIncidentPriority,
) Adds a new incident priority to the current project |
| RemoteIncidentSeverity | Incident_AddSeverity ( RemoteIncidentSeverity?
remoteIncidentSeverity,
) Adds a new incident severity to the current project |
| RemoteIncidentStatus | Incident_AddStatus ( RemoteIncidentStatus?
remoteIncidentStatus,
) Adds a new incident status to the current project |
| RemoteIncidentType | Incident_AddType ( RemoteIncidentType?
remoteIncidentType,
) Adds a new incident type to the current project |
| long | Incident_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of incidents that match the filter. |
| RemoteIncident | Incident_Create ( RemoteIncident?
remoteIncident,
) Creates a new incident in the system |
| Incident_Delete ( int incidentId,
) Deletes a incident in the system | |
| ArrayOfRemoteIncident | Incident_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of incidents in the system that match the provided filter/sort |
| RemoteIncident | Incident_RetrieveById ( int incidentId,
) Retrieves a single incident in the system |
| ArrayOfRemoteIncident | Incident_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) |
| ArrayOfRemoteIncident | Incident_RetrieveByTestRunStep ( int testRunStepId,
) Retrieves a list of incidents in the system that are linked to a specific test run step |
| ArrayOfRemoteIncident | Incident_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) |
| ArrayOfRemoteComment | Incident_RetrieveComments ( int incidentId,
) Retrieves the incident resolutions for an incident |
| RemoteIncidentStatus | Incident_RetrieveDefaultStatus Retrieves the default incident status for the current project |
| RemoteIncidentType | Incident_RetrieveDefaultType Retrieves the default incident type for the current project |
| ArrayOfRemoteIncident | Incident_RetrieveForOwner Retrieves all open incidents owned by the currently authenticated user |
| ArrayOfRemoteIncident | Incident_RetrieveNew ( dateTime creationDate,
int startRow,
int numberOfRows,
) Retrieves all new incidents added in the system since the date specified |
| ArrayOfRemoteIncidentPriority | Incident_RetrievePriorities Retrieves a list of the active incident priorities for the current project |
| ArrayOfRemoteIncidentSeverity | Incident_RetrieveSeverities Retrieves a list of the active incident severities for the current project |
| ArrayOfRemoteIncidentStatus | Incident_RetrieveStatuses Retrieves a list of the active incident statuses for the current project |
| ArrayOfRemoteIncidentType | Incident_RetrieveTypes Retrieves a list of the active incident types for the current project |
| ArrayOfRemoteWorkflowIncidentCustomProperties | Incident_RetrieveWorkflowCustomProperties ( int currentTypeId,
int currentStatusId,
) Retrieves the list of incident custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowIncidentFields | Incident_RetrieveWorkflowFields ( int currentTypeId,
int currentStatusId,
) Retrieves the list of incident fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflowIncidentTransition | Incident_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 | |
| RemoteProject | Project_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 | |
| ArrayOfRemoteProject | Project_Retrieve Retrieves a list of projects that the authenticated user has access to |
| RemoteProject | Project_RetrieveById ( int projectId,
) Retrieves a single project in the system |
| ArrayOfRemoteProjectUser | Project_RetrieveUserMembership Retrieves the list of users that are members of the current project |
| ArrayOfRemoteProjectRole | ProjectRole_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 | |
| long | Release_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of releases that match the filter. |
| RemoteRelease | Release_Create ( RemoteRelease?
remoteRelease,
int?
parentReleaseId,
) Creates a new release in the system |
| RemoteComment | Release_CreateComment ( RemoteComment?
remoteComment,
) Creates a new comment for a release. |
| Release_Delete ( int releaseId,
) Deletes a release in the system | |
| Release_Move ( int releaseId,
int?
destinationReleaseId,
) Moves a release to another location in the hierarchy | |
| Release_RemoveTestMapping ( RemoteReleaseTestCaseMapping?
remoteReleaseTestCaseMapping,
) Removes a mapping entry for a specific release and test case | |
| ArrayOfRemoteRelease | Release_Retrieve ( boolean activeOnly,
) Retrieves all the releases and iterations belonging to the current project |
| ArrayOfRemoteRelease | Release_Retrieve2 ( ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of releases in the system that match the provided filter |
| RemoteRelease | Release_RetrieveById ( int releaseId,
) Retrieves a single release in the system |
| ArrayOfRemoteComment | Release_RetrieveComments ( int ReleaseId,
) Retrieves comments for a specified release. |
| ArrayOfRemoteReleaseTestCaseMapping | Release_RetrieveTestMapping ( int releaseId,
) Retrieves the mapped test cases for a specific release |
| Release_Update ( RemoteRelease?
remoteRelease,
) Updates a release in the system | |
| Requirement_AddTestCoverage ( RemoteRequirementTestCaseMapping?
remoteReqTestCaseMapping,
) Maps a requirement to a test case, so that the test case 'covers' the requirement | |
| long | Requirement_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of requirements that match the filter. |
| RemoteRequirement | Requirement_Create1 ( RemoteRequirement?
remoteRequirement,
int indentPosition,
) Creates a new requirement record in the current project using the position offset method |
| RemoteRequirement | Requirement_Create2 ( RemoteRequirement?
remoteRequirement,
int?
parentRequirementId,
) Creates a new requirement in the system |
| RemoteComment | Requirement_CreateComment ( RemoteComment?
remoteComment,
) Creates a new comment for a requirement. |
| Requirement_Delete ( int requirementId,
) Deletes a requirement in the system | |
| 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_Outdent ( int requirementId,
) Outdents a requirement one position | |
| Requirement_RemoveTestCoverage ( RemoteRequirementTestCaseMapping?
remoteReqTestCaseMapping,
) Removes a coverage mapping entry for a specific requirement and test case | |
| ArrayOfRemoteRequirement | Requirement_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of requirements in the system that match the provided filter |
| RemoteRequirement | Requirement_RetrieveById ( int requirementId,
) Retrieves a single requirement in the system |
| ArrayOfRemoteComment | Requirement_RetrieveComments ( int RequirementId,
) Retrieves comments for a specified requirement. |
| ArrayOfRemoteRequirement | Requirement_RetrieveForOwner Retrieves all requirements owned by the currently authenticated user |
| ArrayOfRemoteRequirementTestCaseMapping | Requirement_RetrieveTestCoverage ( int requirementId,
) Retrieves the test coverage for a specific requirement |
| Requirement_Update ( RemoteRequirement?
remoteRequirement,
) Updates a requirement in the system | |
| string | System_GetArtifactUrl ( int navigationLinkId,
int projectId,
int artifactId,
string?
tabName,
) Returns the application-relative URL to a particular artifact in the system |
| string | System_GetProductName Gets the brand name of the product installed |
| RemoteVersion | System_GetProductVersion Retrieves the version number of the current installation. |
| int | System_GetProjectIdForArtifact ( int artifactTypeId,
int artifactId,
) Returns the project ID number that the queried artifact exists in. |
| dateTime | System_GetServerDateTime Retrieves the current date-time on the server converted into UTC |
| ArrayOfRemoteSetting | System_GetSettings Returns the current configuration settings for the installation. |
| string | System_GetWebServerUrl Gets the base URL of the website that the system is running under. Used for notifications and exported artifacts |
| long | Task_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of tasks that match the filter. |
| RemoteTask | Task_Create ( RemoteTask?
remoteTask,
) Creates a new task in the system |
| RemoteComment | Task_CreateComment ( RemoteComment?
remoteComment,
) Creates a new comment for a task. |
| Task_Delete ( int taskId,
) Deletes a task in the system | |
| ArrayOfRemoteTask | Task_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of tasks in the system that match the provided filter/sort |
| RemoteTask | Task_RetrieveById ( int taskId,
) Retrieves a single task in the system |
| ArrayOfRemoteComment | Task_RetrieveComments ( int TaskId,
) Retrieves comments for a specified task. |
| ArrayOfRemoteTask | Task_RetrieveForOwner Retrieves all tasks owned by the currently authenticated user |
| ArrayOfRemoteTask | Task_RetrieveNew ( dateTime creationDate,
int startRow,
int numberOfRows,
) Retrieves all new tasks added in the system since the date specified |
| Task_Update ( RemoteTask?
remoteTask,
) Updates a task in the system | |
| int | TestCase_AddLink ( int testCaseId,
int position,
int linkedTestCaseId,
ArrayOfRemoteTestStepParameter?
parameters,
) Adds a new test step that is actually a link to a test case |
| RemoteTestCaseParameter | TestCase_AddParameter ( RemoteTestCaseParameter?
remoteTestCaseParameter,
) Adds a new parameter for a test case |
| RemoteTestStep | TestCase_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 | |
| long | TestCase_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of test cases that match the filter. |
| long | TestCase_CountForFolder ( ArrayOfRemoteFilter?
remoteFilters,
int parentID,
) Gives a count of items within the given folder that match the filters. |
| RemoteTestCase | TestCase_Create ( RemoteTestCase?
remoteTestCase,
int?
parentTestFolderId,
) Creates a new test case in the system |
| RemoteComment | TestCase_CreateComment ( RemoteComment?
remoteComment,
) Creates a new comment for a test case. |
| RemoteTestCase | TestCase_CreateFolder ( RemoteTestCase?
remoteTestCase,
int?
parentTestFolderId,
) Creates a new test case folder in the system |
| string | TestCase_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_DeleteStep ( int testCaseId,
int testStepId,
) Deletes a test step in the system | |
| TestCase_Move ( int testCaseId,
int?
destinationTestCaseId,
) 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 | |
| ArrayOfRemoteTestCase | TestCase_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of testCases in the system that match the provided filter |
| ArrayOfRemoteTestCase | TestCase_RetrieveByFolder ( int testCaseFolderId,
) Retrieves all test cases that are stored in a particular test folder |
| RemoteTestCase | TestCase_RetrieveById ( int testCaseId,
) Retrieves a single test case/folder in the system |
| ArrayOfRemoteTestCase | TestCase_RetrieveByReleaseId ( int releaseId,
ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of testCases in a particular release that match the provided filter |
| ArrayOfRemoteTestCase | TestCase_RetrieveByTestSetId ( int testSetId,
) Retrieves all the test cases that are part of a test set |
| ArrayOfRemoteComment | TestCase_RetrieveComments ( int TestCaseId,
) Retrieves comments for a specified test case. |
| ArrayOfRemoteTestCaseFolder | TestCase_RetrieveFolderHierarchy Retrieves the entire folder hierarchy. Useful for client applications using v5.0 that need to get the list of all folders but otherwise have not been recoded to use the newer v5.0 API |
| ArrayOfRemoteTestCase | TestCase_RetrieveForOwner Retrieves all testCases owned by the currently authenticated user |
| ArrayOfRemoteTestCaseParameter | TestCase_RetrieveParameters ( int testCaseId,
) Retrieves the list of defined parameters for a test case along with the associated default value |
| ArrayOfRemoteTestStepParameter | TestCase_RetrieveStepParameters ( int testCaseId,
int testStepId,
) Retrieves the list of parameters and provided values for a test link step |
| TestCase_Update ( RemoteTestCase?
remoteTestCase,
) Updates a test case in the system together with its test steps (if populated) | |
| long | TestRun_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of test runs that match the filter. |
| ArrayOfRemoteAutomatedTestRun | TestRun_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 |
| ArrayOfRemoteAutomatedTestRun | TestRun_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 |
| ArrayOfRemoteManualTestRun | TestRun_CreateFromTestCases ( ArrayOfint?
testCaseIds,
int?
releaseId,
) Creates a new test run shell from the provided test case(s) |
| ArrayOfRemoteManualTestRun | TestRun_CreateFromTestSet ( int testSetId,
) Creates a new test run shell from the provided test set |
| RemoteAutomatedTestRun | TestRun_RecordAutomated1 ( RemoteAutomatedTestRun?
remoteTestRun,
) Records the results of executing an automated test |
| int | TestRun_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 |
| ArrayOfRemoteAutomatedTestRun | TestRun_RecordAutomated3 ( ArrayOfRemoteAutomatedTestRun?
remoteTestRuns,
) Records the results of executing multiple automated tests |
| ArrayOfRemoteTestRun | TestRun_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of test runs in the system that match the provided filter/sort |
| ArrayOfRemoteAutomatedTestRun | TestRun_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 |
| RemoteAutomatedTestRun | TestRun_RetrieveAutomatedById ( int testRunId,
) Retrieves a single automated test run in the system including the automation-specific information |
| RemoteTestRun | TestRun_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 |
| ArrayOfRemoteManualTestRun | TestRun_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 |
| RemoteManualTestRun | TestRun_RetrieveManualById ( int testRunId,
) Retrieves a single manual test run in the system including any associated steps |
| ArrayOfRemoteManualTestRun | TestRun_Save ( ArrayOfRemoteManualTestRun?
remoteTestRuns,
dateTime?
endDate,
) Saves set of test runs, each containing test run steps |
| ArrayOfRemoteTestSetTestCaseMapping | TestSet_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 |
| long | TestSet_Count ( ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of test sets that match the filter. |
| RemoteTestSet | TestSet_Create ( RemoteTestSet?
remoteTestSet,
int?
parentTestSetFolderId,
) Creates a new test set in the system |
| RemoteComment | TestSet_CreateComment ( RemoteComment?
remoteComment,
) Creates a new comment for a test set. |
| RemoteTestSet | TestSet_CreateFolder ( RemoteTestSet?
remoteTestSet,
int?
parentTestSetFolderId,
) Creates a new test set folder in the system |
| TestSet_Delete ( int testSetId,
) 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 | |
| ArrayOfRemoteTestSet | TestSet_Retrieve ( ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of testSets in the system that match the provided filter |
| RemoteTestSet | TestSet_RetrieveById ( int testSetId,
) Retrieves a single test set/folder in the system |
| ArrayOfRemoteComment | TestSet_RetrieveComments ( int TestSetId,
) Retrieves comments for a specified test set. |
| ArrayOfRemoteTestSet | TestSet_RetrieveForOwner Retrieves all testSets owned by the currently authenticated user |
| ArrayOfRemoteTestSetTestCaseMapping | TestSet_RetrieveTestCaseMapping ( int testSetId,
) Retrieves all the test cases that are part of a test set |
| TestSet_Update ( RemoteTestSet?
remoteTestSet,
) Updates a test set in the system | |
| RemoteUser | User_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. | |
| RemoteUser | User_RetrieveById ( int userId,
) Retrieves a single user in the system |
| RemoteUser | User_RetrieveByUserName ( string?
userName,
) Retrieves a single user in the system by user-name |