SpiraPlan: SoapService SOAP Web Service (v7.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 SpiraPlan, SpiraTeam, or SpiraTest installations v7.5 or greater. There are older APIs available for older versions of the system (v6_0, v5_0, 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 |
|---|---|
| RemoteAssociation | Association_Create ( RemoteCredentials?
credentials,
int projectId,
RemoteAssociation?
remoteAssociation,
) Adds a new association in the system |
| Association_Delete ( RemoteCredentials?
credentials,
int projectId,
int artifactLinkId,
) Deletes an association between two artifacts | |
| ArrayOfRemoteAssociation | Association_RetrieveForArtifact ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
) Retrieves a set of associations to the specified artifact |
| Association_Update ( RemoteCredentials?
credentials,
int projectId,
RemoteAssociation?
remoteAssociation,
) Updates the specified Association's information | |
| RemoteAutomationEngine | AutomationEngine_Create ( RemoteCredentials?
credentials,
RemoteAutomationEngine?
remoteEngine,
) Creates a new Automation Engine in the system. |
| ArrayOfRemoteAutomationEngine | AutomationEngine_Retrieve ( RemoteCredentials?
credentials,
boolean activeOnly,
) Retrieves the list of automation engines in the system |
| RemoteAutomationEngine | AutomationEngine_RetrieveById ( RemoteCredentials?
credentials,
int automationEngineId,
) Retrieves a single automation engine record by its ID |
| RemoteAutomationEngine | AutomationEngine_RetrieveByToken ( RemoteCredentials?
credentials,
string?
token,
) Retrieves a single automation engine record by its Token |
| AutomationEngine_Update ( RemoteCredentials?
credentials,
RemoteAutomationEngine?
remoteEngine,
) Updates an existing automation engine in the system | |
| RemoteAutomationHost | AutomationHost_Create ( RemoteCredentials?
credentials,
RemoteAutomationHost?
remoteAutomationHost,
) Creates a new automation host in the system |
| AutomationHost_Delete ( RemoteCredentials?
credentials,
int projectId,
int automationHostId,
) Deletes a automation host in the system | |
| ArrayOfRemoteAutomationHost | AutomationHost_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves the list of automation hosts in the current project |
| RemoteAutomationHost | AutomationHost_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int automationHostId,
) Retrieves a single automation host by its id |
| RemoteAutomationHost | AutomationHost_RetrieveByToken ( RemoteCredentials?
credentials,
int projectId,
string?
token,
) Retrieves a single automation host by its token name |
| AutomationHost_Update ( RemoteCredentials?
credentials,
RemoteAutomationHost?
remoteAutomationHost,
) Updates an automation host in the system | |
| RemoteBuild | Build_Create ( RemoteCredentials?
credentials,
RemoteBuild?
remoteBuild,
) Creates a new build in the system, including any linked source code revisions |
| Build_DeleteForRelease ( RemoteCredentials?
credentials,
int projectId,
int releaseId,
) Deletes all builds on a release | |
| RemoteBuild | Build_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
int buildId,
) Retrieves the a single build (and associated source code revisions) by its id |
| RemoteBuild | Build_RetrieveById_NoDescription ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
int buildId,
) Retrieves the a single build (and associated source code revisions) by its id, without including the build description field |
| ArrayOfRemoteBuild | Build_RetrieveByReleaseId ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves the list of builds that are associated with a specific Release |
| ArrayOfRemoteBuild | Build_RetrieveByReleaseId_NoDescription ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves the list of builds that are associated with a specific Release, without including the build description fields |
| RemoteCapabilityPriority | Capability_AddPriority ( RemoteCredentials?
credentials,
RemoteCapabilityPriority?
remoteCapabilityPriority,
) Adds a new capability priority to the system |
| Capability_AddRequirementAssociation ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
int requirementId,
) Adds a requirement association to a capability | |
| RemoteCapabilityStatus | Capability_AddStatus ( RemoteCredentials?
credentials,
RemoteCapabilityStatus?
remoteCapabilityStatus,
) Adds a new capability status to the system |
| RemoteCapabilityType | Capability_AddType ( RemoteCredentials?
credentials,
RemoteCapabilityType?
remoteCapabilityType,
) Adds a new capability type to the system |
| RemoteCapability | Capability_Create ( RemoteCredentials?
credentials,
int programId,
RemoteCapability?
remoteCapability,
) Creates a new program capability |
| RemoteCapability | Capability_CreateChild ( RemoteCredentials?
credentials,
int programId,
int parentCapabilityId,
RemoteCapability?
remoteCapability,
) Creates a new program capability under the specified parent Capability |
| Capability_Delete ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Deletes a capability from a given program | |
| Capability_Indent ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Indents a capability from a given program | |
| Capability_Move ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
int destCapabilityId,
) Moves a capability in the hierarchy in a given program | |
| Capability_Outdent ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Outdents a capability from a given program | |
| Capability_RemoveRequirementAssociation ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
int requirementId,
) Removes a requirement association from a capability | |
| ArrayOfRemoteCapability | Capability_Retrieve ( RemoteCredentials?
credentials,
int programId,
int currentPage,
int pageSize,
) Retrieves a list of capabilities in a given program |
| RemoteCapability | Capability_RetrieveById ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Retrieves a single program capability from the program |
| ArrayOfRemoteCapability | Capability_RetrieveChildren ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Retrieves all the children capability of a given capabilityId from the program |
| ArrayOfRemoteAssociation | Capability_RetrieveFilteredRequirementAssociations ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
int pageSize,
int currentPage,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves a paginated list of requirement associations for a given capability |
| ArrayOfRemoteCapabilityPriority | Capability_RetrievePriorities ( RemoteCredentials?
credentials,
) Retrieves the list of capability priorities in the system |
| RemoteCapabilityPriority | Capability_RetrievePriorityById ( RemoteCredentials?
credentials,
int capabilityPriorityId,
) Retrieves a single capability priority from the system |
| ArrayOfRemoteAssociation | Capability_RetrieveRequirementAssociations ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
) Retrieves the requirement associations for a given capability |
| RemoteCapabilityStatus | Capability_RetrieveStatusById ( RemoteCredentials?
credentials,
int capabilityStatusId,
) Retrieves a single capability status from the system |
| ArrayOfRemoteCapabilityStatus | Capability_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves a list of the capability statuses of the system |
| RemoteCapabilityType | Capability_RetrieveTypeById ( RemoteCredentials?
credentials,
int capabilityTypeId,
) Retrieves a single capability type from the system |
| ArrayOfRemoteCapabilityType | Capability_RetrieveTypes ( RemoteCredentials?
credentials,
) Retrieves the list of capability types in the system |
| ArrayOfRemoteCapability | Capability_SortedRetrieve ( RemoteCredentials?
credentials,
int programId,
int startingRow,
int numberOfRows,
string?
sortField,
boolean sortAscending,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves a sorted list of capabilities in a given program that match the provided filter |
| Capability_Update ( RemoteCredentials?
credentials,
int programId,
int capabilityId,
RemoteCapability?
remoteCapability,
) Updates a program capability | |
| Capability_UpdatePriority ( RemoteCredentials?
credentials,
RemoteCapabilityPriority?
remoteCapabilityPriority,
) Updates a capability priority in the system | |
| Capability_UpdateStatus ( RemoteCredentials?
credentials,
RemoteCapabilityStatus?
remoteCapabilityStatus,
) Updates an existing capability status in the in the system | |
| Capability_UpdateType ( RemoteCredentials?
credentials,
RemoteCapabilityType?
remoteCapabilityType,
) Updates a capability type in the system | |
| RemoteComponent | Component_Create ( RemoteCredentials?
credentials,
RemoteComponent?
remoteComponent,
) Creates a new component in the current project |
| Component_Delete ( RemoteCredentials?
credentials,
int projectId,
int componentId,
) Deletes a component in the current project | |
| ArrayOfRemoteComponent | Component_Retrieve ( RemoteCredentials?
credentials,
int projectId,
boolean activeOnly,
boolean includeDeleted,
) Retrieves a list of all the components in the current project |
| RemoteComponent | Component_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int componentId,
) Retrieves a single component by its ID |
| Component_Undelete ( RemoteCredentials?
credentials,
int projectId,
int componentId,
) Undeletes a component in the current project | |
| Component_Update ( RemoteCredentials?
credentials,
RemoteComponent?
remoteComponent,
) Updates an existing component in the current project | |
| RemoteCredentials | Connection_Authenticate1 ( 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 |
| RemoteCredentials | Connection_Authenticate2 ( 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 |
| RemoteCustomList | CustomProperty_AddCustomList ( RemoteCredentials?
credentials,
RemoteCustomList?
remoteCustomList,
) Adds a new custom list into the project template |
| RemoteCustomListValue | CustomProperty_AddCustomListValue ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteCustomListValue?
remoteCustomListValue,
) Adds a new custom property list value into the system |
| RemoteCustomProperty | CustomProperty_AddDefinition ( RemoteCredentials?
credentials,
RemoteCustomProperty?
remoteCustomProperty,
int?
customListId,
) Adds a new custom property definition to the project for the specified artifact type |
| CustomProperty_DeleteDefinition ( RemoteCredentials?
credentials,
int projectTemplateId,
int customPropertyId,
) Deletes a custom property definition from the system, including any associated options | |
| RemoteCustomList | CustomProperty_RetrieveCustomListById ( RemoteCredentials?
credentials,
int projectTemplateId,
int customListId,
) Retrieves a custom list by its ID, including any custom list values |
| ArrayOfRemoteCustomList | CustomProperty_RetrieveCustomLists ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all the custom lists in the current project template |
| ArrayOfRemoteCustomProperty | CustomProperty_RetrieveForArtifactType ( RemoteCredentials?
credentials,
int projectTemplateId,
int artifactTypeId,
boolean includeDeleted,
) Retrieves the list of custom properties configured for the current project and the specified artifact type |
| CustomProperty_UpdateCustomList ( RemoteCredentials?
credentials,
RemoteCustomList?
remoteCustomList,
) Updates a custom list and any associated values in the system | |
| CustomProperty_UpdateDefinition ( RemoteCredentials?
credentials,
RemoteCustomProperty?
remoteCustomProperty,
) Updates a custom property definition, including any associated options | |
| DataMapping_AddArtifactMappings ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactTypeId,
ArrayOfRemoteDataMapping?
remoteDataMappings,
) Adds new artifact data mapping entries | |
| DataMapping_AddUserMappings ( RemoteCredentials?
credentials,
int dataSyncSystemId,
ArrayOfRemoteDataMapping?
remoteDataMappings,
) Adds new user data mapping entries | |
| DataMapping_RemoveArtifactMappings ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactTypeId,
ArrayOfRemoteDataMapping?
remoteDataMappings,
) Removes existing artifact data mapping entries | |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveArtifactMappings ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactTypeId,
) Retrieves a list of data mappings for artifact ids in the system |
| RemoteDataMapping | DataMapping_RetrieveCustomPropertyMapping ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactTypeId,
int customPropertyId,
) Retrieves the data mapping for a custom property |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveCustomPropertyValueMappings ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactTypeId,
int customPropertyId,
) Retrieves a list of data mappings for custom property values |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveFieldValueMappings ( RemoteCredentials?
credentials,
int projectId,
int dataSyncSystemId,
int artifactFieldId,
) Retrieves a list of data mappings for artifact field values |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveProjectMappings ( RemoteCredentials?
credentials,
int dataSyncSystemId,
) Retrieves a list of data mappings for projects in the system |
| ArrayOfRemoteDataMapping | DataMapping_RetrieveUserMappings ( RemoteCredentials?
credentials,
int dataSyncSystemId,
) Retrieves a list of data mappings for users in the system |
| ArrayOfRemoteProjectArtifact | DataMapping_SearchArtifactMappings ( RemoteCredentials?
credentials,
int dataSyncSystemId,
int artifactTypeId,
string?
externalKey,
) Retrieves a list of data mappings for a specific artifact across all projects in the system the user is authorized to view |
| RemoteDataSyncSystem | DataSyncSystem_Create ( RemoteCredentials?
credentials,
RemoteDataSyncSystem?
remoteDataSyncSystem,
) Creates a new data sync system entry |
| ArrayOfRemoteDataSyncSystem | DataSyncSystem_Retrieve ( RemoteCredentials?
credentials,
) Retrieves a list of data-sync plug-ins that need to be synchronized with |
| RemoteDataSyncSystem | DataSyncSystem_RetrieveById ( RemoteCredentials?
credentials,
int dataSyncSystemId,
) Retrieves a single data sync system by its ID |
| DataSyncSystem_SaveRunFailure ( RemoteCredentials?
credentials,
int dataSyncSystemId,
) Updates the status for a failed data-sync plug-in | |
| DataSyncSystem_SaveRunningState ( RemoteCredentials?
credentials,
int dataSyncSystemId,
) Updates the status for a data-sync plug-in that just started executing to 'Running' | |
| DataSyncSystem_SaveRunSuccess ( RemoteCredentials?
credentials,
int dataSyncSystemId,
dateTime lastRunDate,
) Updates the status for a successful data-sync plug-in | |
| DataSyncSystem_SaveRunWarning ( RemoteCredentials?
credentials,
int dataSyncSystemId,
dateTime lastRunDate,
) Updates the status for a data-sync plug-in that executed with warnings | |
| DataSyncSystem_Update ( RemoteCredentials?
credentials,
RemoteDataSyncSystem?
remoteDataSyncSystem,
) Updates an existing data sync system entry | |
| DataSyncSystem_WriteEvent ( RemoteCredentials?
credentials,
string?
message,
string?
details,
int eventLogEntryType,
) Writes an error/warning event entry to the SpiraTeam database log | |
| RemoteDocument | Document_AddFile ( RemoteCredentials?
credentials,
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 ( RemoteCredentials?
credentials,
int projectId,
RemoteDocumentVersion?
remoteDocumentVersion,
base64Binary?
binaryData,
boolean makeCurrent,
) Adds a new version to a file attachment in the system |
| RemoteDocumentFolder | Document_AddFolder ( RemoteCredentials?
credentials,
RemoteDocumentFolder?
remoteDocumentFolder,
) Adds a new document folder into the current project |
| RemoteDocumentStatus | Document_AddStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteDocumentStatus?
remoteDocumentStatus,
) Adds a new document status to the specified project template |
| Document_AddToArtifactId ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
int attachmentId,
) Adds an existing attachment to the specified artifact. | |
| RemoteDocumentType | Document_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteDocumentType?
remoteDocumentType,
) Adds a new document type to the current project template |
| RemoteDocument | Document_AddUrl ( RemoteCredentials?
credentials,
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 ( RemoteCredentials?
credentials,
int projectId,
RemoteDocumentVersion?
remoteDocumentVersion,
boolean makeCurrent,
) Adds a new version to a URL attachment in the system |
| RemoteWorkflow | Document_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for documents in the specified project template |
| RemoteWorkflowTransition | Document_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a document workflow |
| Document_Delete ( RemoteCredentials?
credentials,
int projectId,
int attachmentId,
) Deletes an attachment from the project completely | |
| Document_DeleteFolder ( RemoteCredentials?
credentials,
int projectId,
int projectAttachmentFolderId,
) Deletes an existing document folder from the current project | |
| Document_DeleteFromArtifact ( RemoteCredentials?
credentials,
int projectId,
int attachmentId,
int artifactTypeId,
int artifactId,
) Deletes an attachment from an artifact. The attachment will still remain in the project | |
| Document_DeleteVersion ( RemoteCredentials?
credentials,
int projectId,
int attachmentVersionId,
) Deletes an attachment version from the project completely | |
| Document_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Document_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| base64Binary | Document_OpenFile ( RemoteCredentials?
credentials,
int projectId,
int attachmentId,
) Returns the actual binary content of a file attachment in the system |
| base64Binary | Document_OpenVersion ( RemoteCredentials?
credentials,
int projectId,
int attachmentVersionId,
) Returns the actual binary content of a specific version of an attachment in the system |
| ArrayOfRemoteDocument | Document_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberRows,
) Retrieves a filtered list of documents/attachments in a project across all folders |
| RemoteDocument | Document_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int attachmentId,
) Retrieves a single project document by its id |
| RemoteDocumentType | Document_RetrieveDefaultType ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the default document type for the current project template |
| RemoteDocumentFolder | Document_RetrieveFolderById ( RemoteCredentials?
credentials,
int projectId,
int folderId,
) Retrieves the folder by the specified ID. |
| ArrayOfRemoteDocumentFolder | Document_RetrieveFolders ( RemoteCredentials?
credentials,
int projectId,
) Retrieves a list of all the document folders in the current project |
| ArrayOfRemoteDocumentFolder | Document_RetrieveFoldersByParentFolderId ( RemoteCredentials?
credentials,
int projectId,
int?
parentFolderId,
) Retrieves a list of all the document folders directly under the specified parent folder |
| ArrayOfRemoteDocument | Document_RetrieveForArtifact ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int folderId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberRows,
) Retrieves a filtered list of documents/attachments in a project for the specified folder |
| ArrayOfRemoteDocumentStatus | Document_RetrieveStatuses ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a list of all the document statuses in the current project |
| ArrayOfRemoteDocumentType | Document_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
boolean activeOnly,
) Retrieves a list of all the document types in the current project template |
| RemoteWorkflow | Document_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Document_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Document_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int documentTypeId,
int currentStatusId,
) Retrieves the list of document custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Document_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int documentStatusId,
) Retrieves the list of document fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Document_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int documentTypeId,
int documentStatusId,
) Retrieves the list of document fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Document_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for documents in a given project template |
| ArrayOfRemoteWorkflowTransition | Document_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given document status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Document_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
int currentTypeId,
int currentStatusId,
boolean isCreator,
boolean isOwner,
) Will retrieve available transitions for the specied status ID for the currently logged-on user. |
| Document_Update ( RemoteCredentials?
credentials,
int projectId,
RemoteDocument?
remoteDocument,
) Updates information about a document (version information is not updated) | |
| Document_UpdateFolder ( RemoteCredentials?
credentials,
RemoteDocumentFolder?
remoteDocumentFolder,
) Updates the name and position of an existing folder in the project | |
| Document_UpdateStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteDocumentStatus?
remoteDocumentStatus,
) Updates a document status in the system | |
| Document_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteDocumentType?
remoteDocumentType,
) Updates an existing document type to the current project template | |
| Document_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Document_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int documentStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Document_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int documentStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Document_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature document (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| RemoteFloatingLicense | FloatingLicense_CreateNewSession ( RemoteCredentials?
credentials,
string?
automationEngineToken,
string?
automationHost,
string?
machineId,
dateTime expirationDate,
string?
ipAddress,
) Creates a new floating license session |
| RemoteFloatingLicense | FloatingLicense_ExtendSession ( RemoteCredentials?
credentials,
string?
automationEngineToken,
string?
automationHost,
string?
sessionId,
dateTime expirationDate,
) Extends the current floating license session |
| ArrayOfRemoteIntegerSetting | FloatingLicense_GetLicenseCounts ( RemoteCredentials?
credentials,
string?
automationEngineToken,
) Gets the count of licenses purchased, available and in use at the present time |
| RemoteFloatingLicense | FloatingLicense_GetLicenseInfoBySessionId ( RemoteCredentials?
credentials,
string?
automationEngineToken,
string?
automationHost,
string?
sessionId,
) Retrieves the current floating license session |
| boolean | FloatingLicense_ReleaseSession ( RemoteCredentials?
credentials,
string?
automationEngineToken,
string?
automationHost,
string?
sessionId,
) Releases the current floating license session for use by another user |
| RemoteHistoryChangeSet | History_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int historyChangeSetId,
) Retrieves the details of a specific change made |
| ArrayOfRemoteHistoryChange | History_RetrieveForArtifact ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
int startingRow,
int numberOfRows,
RemoteSort?
remoteSort,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves the history of changes for a specific artifact |
| ArrayOfRemoteComment | Incident_AddComments ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteComment?
remoteComments,
) Adds new incident comments to incidents in the system |
| RemoteIncidentPriority | Incident_AddPriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentPriority?
remoteIncidentPriority,
) Adds a new incident priority to the current project template |
| RemoteIncidentSeverity | Incident_AddSeverity ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentSeverity?
remoteIncidentSeverity,
) Adds a new incident severity to the current project template |
| RemoteIncidentStatus | Incident_AddStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentStatus?
remoteIncidentStatus,
) Adds a new incident status to the current project template |
| RemoteIncidentType | Incident_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentType?
remoteIncidentType,
) Adds a new incident type to the current project template |
| long | Incident_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of incidents that match the filter. |
| RemoteIncident | Incident_Create ( RemoteCredentials?
credentials,
RemoteIncident?
remoteIncident,
) Creates a new incident in the system |
| RemoteWorkflow | Incident_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for incidents in the specified project template |
| RemoteWorkflowTransition | Incident_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a incident workflow |
| Incident_Delete ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Deletes a incident in the system | |
| Incident_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Incident_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| ArrayOfRemoteIncident | Incident_Retrieve ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Retrieves a single incident in the system |
| ArrayOfRemoteIncident | Incident_RetrieveByTestCase ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int testRunStepId,
) Retrieves a list of incidents in the system that are linked to a specific test run step |
| ArrayOfRemoteIncident | Incident_RetrieveByTestStep ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Retrieves the incident resolutions for an incident |
| RemoteIncidentStatus | Incident_RetrieveDefaultStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the default incident status for the current project |
| RemoteIncidentType | Incident_RetrieveDefaultType ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the default incident type for the current project |
| ArrayOfRemoteIncident | Incident_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all open incidents owned by the currently authenticated user |
| ArrayOfRemoteIncident | Incident_RetrieveNew ( RemoteCredentials?
credentials,
int projectId,
dateTime creationDate,
int startRow,
int numberOfRows,
) Retrieves all new incidents added in the system since the date specified |
| ArrayOfRemoteIncidentPriority | Incident_RetrievePriorities ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a list of the active incident priorities for the current project |
| ArrayOfRemoteIncidentSeverity | Incident_RetrieveSeverities ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a list of the active incident severities for the current project |
| ArrayOfRemoteIncidentStatus | Incident_RetrieveStatuses ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a list of the active incident statuses for the current project |
| ArrayOfRemoteIncidentType | Incident_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a list of the active incident types for the current project |
| RemoteWorkflow | Incident_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Incident_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Incident_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int incidentTypeId,
int currentStatusId,
) Retrieves the list of incident custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Incident_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
) Retrieves the list of incident fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Incident_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int incidentTypeId,
int incidentStatusId,
) Retrieves the list of incident fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Incident_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for incidents in a given project template |
| ArrayOfRemoteWorkflowTransition | Incident_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given incident status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Incident_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
int currentTypeId,
int currentStatusId,
boolean isCreator,
boolean isOwner,
) Will retrieve available transitions for the specied status ID for the currently logged-on user. |
| Incident_Update ( RemoteCredentials?
credentials,
RemoteIncident?
remoteIncident,
) Updates an incident in the system | |
| Incident_UpdatePriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentPriority?
remoteIncidentPriority,
) Updates an existing incident priority in the specified project template in the system | |
| Incident_UpdateResolvedBuild ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
int buildId,
) Updates the field 'ResolvedBuild' of a given incident (already present in the system) | |
| Incident_UpdateSeverity ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentSeverity?
remoteIncidentSeverity,
) Updates an existing incident severity in the specified project template in the system | |
| Incident_UpdateStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentStatus?
remoteIncidentStatus,
) Updates an existing incident status in the specified project template in the system | |
| Incident_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteIncidentType?
remoteIncidentType,
) Updates an existing incident type in the specified project template in the system | |
| Incident_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Incident_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Incident_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Incident_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature incident (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| RemoteMessageInfo | Message_GetInfo ( RemoteCredentials?
credentials,
) Retrieves the IM status for the current user |
| ArrayOfRemoteUserMessage | Message_GetUnreadMessageSenders ( RemoteCredentials?
credentials,
) Gets the list of users and number of unread messages from them |
| Message_MarkAllAsRead ( RemoteCredentials?
credentials,
int senderUserId,
) Marks all the messages as read for a specific sending user | |
| long | Message_PostNew ( RemoteCredentials?
credentials,
int recipientUserId,
string?
message,
) Posts a new message to a specific recipient |
| ArrayOfRemoteMessage | Message_RetrieveUnread ( RemoteCredentials?
credentials,
) Retrieves the list of unread messages |
| ArrayOfRemoteProgram | Program_Retrieve ( RemoteCredentials?
credentials,
) Retrieves a particular program by its ID |
| RemoteProgram | Program_RetrieveById ( RemoteCredentials?
credentials,
int programId,
) Retrieves a particular program by its ID |
| ProgramMilestone_AddReleaseAssociation ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
int releaseId,
) Adds a release association to a milestone | |
| RemoteProgramMilestoneStatus | ProgramMilestone_AddStatus ( RemoteCredentials?
credentials,
RemoteProgramMilestoneStatus?
remoteStatus,
) Creates a program milestone status |
| RemoteProgramMilestoneType | ProgramMilestone_AddType ( RemoteCredentials?
credentials,
RemoteProgramMilestoneType?
remoteType,
) Allows the user to create a program milestone type |
| RemoteProgramMilestone | ProgramMilestone_Create ( RemoteCredentials?
credentials,
int programId,
RemoteProgramMilestone?
remoteMilestone,
) Creates a new program milestone |
| ProgramMilestone_Delete ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
) Deletes a milestone from a given program | |
| ProgramMilestone_RemoveReleaseAssociation ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
int releaseId,
) Removes a release association from a milestone | |
| ArrayOfRemoteProgramMilestone | ProgramMilestone_Retrieve ( RemoteCredentials?
credentials,
int programId,
) Retrieves all the milestones within a program |
| RemoteProgramMilestone | ProgramMilestone_RetrieveById ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
) Retrieves 1 program milestone by ID |
| ArrayOfRemoteAssociation | ProgramMilestone_RetrieveFilteredReleaseAssociations ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
int pageSize,
int currentPage,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves a paginated list of release associations for a given milestone |
| ArrayOfRemoteAssociation | ProgramMilestone_RetrieveReleaseAssociations ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
) Retrieves the release associations for a given milestone |
| RemoteProgramMilestoneStatus | ProgramMilestone_RetrieveStatusById ( RemoteCredentials?
credentials,
int StatusId,
) Retrieves a specific program milestone status |
| ArrayOfRemoteProgramMilestoneStatus | ProgramMilestone_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves the statuses for program milestones |
| RemoteProgramMilestoneType | ProgramMilestone_RetrieveTypeById ( RemoteCredentials?
credentials,
int typeId,
) Retrieves a specific program milestone type |
| ArrayOfRemoteProgramMilestoneType | ProgramMilestone_RetrieveTypes ( RemoteCredentials?
credentials,
) Retrieves the types for program milestones |
| ArrayOfRemoteProgramMilestone | ProgramMilestone_SortedRetrieve ( RemoteCredentials?
credentials,
int programId,
int startingRow,
int numberOfRows,
string?
sortField,
boolean sortAscending,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves pages of the milestones within a program |
| ProgramMilestone_Update ( RemoteCredentials?
credentials,
int programId,
int milestoneId,
RemoteProgramMilestone?
remoteMilestone,
) Updates a program milestone | |
| ProgramMilestone_UpdateStatus ( RemoteCredentials?
credentials,
RemoteProgramMilestoneStatus?
remoteStatus,
) Updates an existing program milestone status | |
| ProgramMilestone_UpdateType ( RemoteCredentials?
credentials,
RemoteProgramMilestoneType?
remoteType,
) Updates a program milestone type | |
| Project_AddUserMembership ( RemoteCredentials?
credentials,
RemoteProjectUser?
remoteProjectUser,
) Adds users to a project with a specific role | |
| RemoteProject | Project_Create ( RemoteCredentials?
credentials,
RemoteProject?
remoteProject,
int?
existingProjectId,
) Creates a new project in the system and makes the authenticated user owner of it |
| Project_Delete ( RemoteCredentials?
credentials,
int projectId,
) Deletes an existing project in the system | |
| Project_RefreshProgressExecutionStatusCaches ( RemoteCredentials?
credentials,
int projectId,
int?
incidentId,
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 | |
| Project_RemoveUserMembership ( RemoteCredentials?
credentials,
RemoteProjectUser?
remoteProjectUser,
) Removes users from a project | |
| ArrayOfRemoteProject | Project_Retrieve ( RemoteCredentials?
credentials,
) Retrieves a list of projects that the authenticated user has access to |
| RemoteProject | Project_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
) Retrieves a single project in the system |
| ArrayOfRemoteProjectUser | Project_RetrieveUserMembership ( RemoteCredentials?
credentials,
int projectId,
) Retrieves the list of users that are members of the current project |
| Project_Update ( RemoteCredentials?
credentials,
RemoteProject?
remoteProject,
) Updates an existing project | |
| Project_UpdateUserMembership ( RemoteCredentials?
credentials,
RemoteProjectUser?
remoteProjectUser,
) Updates the user's role on a specific project | |
| RemoteProjectRole | ProjectRole_Create ( RemoteCredentials?
credentials,
RemoteProjectRole?
remoteProjectRole,
) |
| ProjectRole_Delete ( RemoteCredentials?
credentials,
int projectRoleId,
) Deletes a project role from the system. Fails if the project role is undeletable or currently in use for any user in any product. | |
| ArrayOfRemoteProjectRole | ProjectRole_Retrieve ( RemoteCredentials?
credentials,
) Retrieves a list of project roles in the system |
| ProjectRole_Update ( RemoteCredentials?
credentials,
RemoteProjectRole?
remoteProjectRole,
) | |
| RemoteProjectTemplate | ProjectTemplate_Create ( RemoteCredentials?
credentials,
RemoteProjectTemplate?
remoteProjectTemplate,
int?
existingProjectTemplateId,
) Creates a new project template |
| RemoteProjectTemplate | ProjectTemplate_CreateBlank ( RemoteCredentials?
credentials,
RemoteProjectTemplate?
remoteTemplate,
) Creates a blank project template (This template will not be functional without admin configuration of at least types, statuses and workflows for all artifacts.) |
| ProjectTemplate_Delete ( RemoteCredentials?
credentials,
int projectTemplateId,
) Deletes an existing project template | |
| ArrayOfRemoteProjectTemplate | ProjectTemplate_Retrieve ( RemoteCredentials?
credentials,
) Retrieves the list of project templates |
| RemoteProjectTemplate | ProjectTemplate_RetrieveById ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves a single project template |
| ProjectTemplate_Update ( RemoteCredentials?
credentials,
RemoteProjectTemplate?
remoteProjectTemplate,
) Updates an existing project template | |
| RemotePullRequest | PullRequest_Create ( RemoteCredentials?
credentials,
int projectId,
RemotePullRequest?
remotePullRequest,
) Creates a pull request using the source and dest branch names. If the name of the pull request is left blank it will be populated with the default PR naming scheme. |
| PullRequest_Delete ( RemoteCredentials?
credentials,
int projectId,
int pullRequestId,
) Deletes a pull request from the internal system | |
| ArrayOfRemotePullRequest | PullRequest_Retrieve ( RemoteCredentials?
credentials,
int projectId,
int startRow,
int numberOfRows,
) Retrieves all pull requests from a certain project |
| RemotePullRequest | PullRequest_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int pullRequestId,
) Retrieves a pull request by its Id (TaskId) |
| PullRequest_Update ( RemoteCredentials?
credentials,
RemotePullRequest?
remotePullRequest,
) Updates a pull request in the system. Pull request branches cannot be changed after pull request creation. | |
| Release_AddTestMapping ( RemoteCredentials?
credentials,
int projectId,
RemoteReleaseTestCaseMapping?
remoteReleaseTestCaseMapping,
) Maps a release to a test case, so that the test case is needs to be tested for that release | |
| Release_AddTestMapping2 ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of releases that match the filter. |
| RemoteRelease | Release_Create ( RemoteCredentials?
credentials,
RemoteRelease?
remoteRelease,
int?
parentReleaseId,
) Creates a new release in the system |
| RemoteComment | Release_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a release. |
| RemoteWorkflow | Release_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for releases in the specified project template |
| RemoteWorkflowTransition | Release_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a release workflow |
| Release_Delete ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Deletes a release in the system | |
| Release_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Release_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| Release_Indent ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Indents a release one position | |
| Release_Move ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
int?
destinationReleaseId,
) Moves a release to another location in the hierarchy | |
| Release_Outdent ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Outdents a release one position | |
| Release_RemoveTestMapping ( RemoteCredentials?
credentials,
int projectId,
RemoteReleaseTestCaseMapping?
remoteReleaseTestCaseMapping,
) Removes a mapping entry for a specific release and test case | |
| ArrayOfRemoteRelease | Release_Retrieve ( RemoteCredentials?
credentials,
int projectId,
boolean activeOnly,
) Retrieves all the releases and iterations belonging to the current project |
| ArrayOfRemoteRelease | Release_Retrieve2 ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of releases in the system that match the provided filter |
| RemoteRelease | Release_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Retrieves a single release in the system |
| ArrayOfRemoteRelease | Release_RetrieveChildren ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Retrieves a list of children releases of a release |
| ArrayOfRemoteComment | Release_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int ReleaseId,
) Retrieves comments for a specified release. |
| ArrayOfRemoteReleaseStatus | Release_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves the list of release statuses in the system |
| ArrayOfRemoteReleaseTestCaseMapping | Release_RetrieveTestMapping ( RemoteCredentials?
credentials,
int projectId,
int incidentId,
) Retrieves the mapped test cases for a specific release |
| ArrayOfRemoteReleaseType | Release_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of release types in the system, with the workflows for the specific project template |
| RemoteWorkflow | Release_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Release_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Release_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int incidentTypeId,
int currentStatusId,
) Retrieves the list of release custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Release_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
) Retrieves the list of release fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Release_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int incidentTypeId,
int incidentStatusId,
) Retrieves the list of release fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Release_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for releases in a given project template |
| ArrayOfRemoteWorkflowTransition | Release_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given release status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Release_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
RemoteRelease?
remoteRelease,
) Updates a release in the system | |
| Release_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Release_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Release_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int incidentStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Release_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature release (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| int | Reports_CheckGeneratedReportStatus ( RemoteCredentials?
credentials,
int projectId,
guid reportGenerationId,
) Checks on the status of the generation of a specific user's saved report |
| guid | Reports_GenerateSavedReport ( RemoteCredentials?
credentials,
int projectId,
int savedReportId,
) Starts the generation of a specific user's saved report |
| RemoteTableData | Reports_RetrieveCustomGraphData ( RemoteCredentials?
credentials,
int customGraphId,
int?
projectId,
int?
projectGroupId,
) Returns the grid of data from a specific custom graph created by an administrator |
| RemoteTableData | Reports_RetrieveESQLQueryData ( RemoteCredentials?
credentials,
string?
query,
) Returns the grid of data from a specific custom graph created by an administrator |
| base64Binary | Reports_RetrieveGeneratedReport ( RemoteCredentials?
credentials,
int projectId,
int generatedReportId,
) Retrieves the contents of the generated report |
| ArrayOfRemoteSavedReport | Reports_RetrieveSaved ( RemoteCredentials?
credentials,
int projectId,
boolean includeShared,
) Retrieves the list of saved reports for a specific user |
| RemoteRequirementImportance | Requirement_AddImportance ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRequirementImportance?
RemoteRequirementImportance,
) Adds a new requirement importance to the system |
| RemoteRequirementStep | Requirement_AddStep ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementStep?
remoteRequirementStep,
int?
existingRequirementStepId,
int?
creatorId,
) Adds a requirement step to a requirement |
| Requirement_AddTestCoverage ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementTestCaseMapping?
remoteReqTestCaseMapping,
) Maps a requirement to a test case, so that the test case 'covers' the requirement | |
| Requirement_AddTestStepCoverage ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementTestStepMapping?
remoteReqTestStepMapping,
) Adds a test step to a requirement | |
| RemoteRequirementType | Requirement_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRequirementType?
remoteRequirementType,
) Adds a new requirement type to the system |
| long | Requirement_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of requirements that match the filter. |
| RemoteRequirement | Requirement_Create1 ( RemoteCredentials?
credentials,
RemoteRequirement?
remoteRequirement,
int indentPosition,
) Creates a new requirement record in the current project using the position offset method |
| RemoteRequirement | Requirement_Create2 ( RemoteCredentials?
credentials,
RemoteRequirement?
remoteRequirement,
int?
parentRequirementId,
) Creates a new requirement in the system |
| RemoteComment | Requirement_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a requirement. |
| RemoteWorkflow | Requirement_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for requirements in the specified project template |
| RemoteWorkflowTransition | Requirement_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a requirement workflow |
| Requirement_Delete ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Deletes a requirement in the system | |
| Requirement_DeleteStep ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
int requirementStepId,
) Deletes a requirement step in the list | |
| Requirement_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Requirement_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| Requirement_Indent ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Indents a requirement one position | |
| Requirement_Move ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
int?
destinationRequirementId,
) Moves a requirement to another location in the hierarchy | |
| Requirement_MoveStep ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
int sourceRequirementStepId,
int?
destinationRequirementStepId,
) Moves a requirement step in the list | |
| Requirement_Outdent ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Outdents a requirement one position | |
| Requirement_RemoveTestCoverage ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementTestCaseMapping?
remoteReqTestCaseMapping,
) Removes a coverage mapping entry for a specific requirement and test case | |
| Requirement_RemoveTestStepCoverage ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementTestStepMapping?
remoteReqTestStepMapping,
) Removes a test step from a requirement | |
| ArrayOfRemoteRequirement | Requirement_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
int startingRow,
int numberOfRows,
) Retrieves a list of requirements in the system that match the provided filter |
| RemoteRequirement | Requirement_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves a single requirement in the system |
| ArrayOfRemoteRequirement | Requirement_RetrieveChildren ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves children requirements of a requirement |
| ArrayOfRemoteComment | Requirement_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves comments for a specified requirement. |
| ArrayOfRemoteRequirement | Requirement_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all requirements owned by the currently authenticated user |
| ArrayOfRemoteRequirementImportance | Requirement_RetrieveImportances ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of requirement importances in the project template |
| ArrayOfRemoteRequirementStatus | Requirement_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves the list of requirement statuses in the system |
| RemoteRequirementStep | Requirement_RetrieveStepById ( RemoteCredentials?
credentials,
int projectId,
int requirementStepId,
) Retrieves a single requirement step by its ID |
| ArrayOfRemoteRequirementStep | Requirement_RetrieveSteps ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves a list of requirement steps |
| ArrayOfRemoteRequirementTestCaseMapping | Requirement_RetrieveTestCoverage ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves the test coverage for a specific requirement |
| ArrayOfRemoteRequirementTestStepMapping | Requirement_RetrieveTestStepCoverage ( RemoteCredentials?
credentials,
int projectId,
int requirementId,
) Retrieves the list of test steps associated with a requirement |
| ArrayOfRemoteRequirementType | Requirement_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of requirement types in the system |
| RemoteWorkflow | Requirement_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Requirement_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Requirement_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int requirementTypeId,
int currentStatusId,
) Retrieves the list of requirement custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Requirement_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int requirementStatusId,
) Retrieves the list of requirement fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Requirement_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int requirementTypeId,
int requirementStatusId,
) Retrieves the list of requirement fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Requirement_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for requirements in a given project template |
| ArrayOfRemoteWorkflowTransition | Requirement_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given requirement status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Requirement_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
RemoteRequirement?
remoteRequirement,
) Updates a requirement in the system | |
| Requirement_UpdateImportance ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRequirementImportance?
RemoteRequirementImportance,
) Updates a requirement importance in the system | |
| Requirement_UpdateStep ( RemoteCredentials?
credentials,
int projectId,
RemoteRequirementStep?
remoteRequirementStep,
) Updates an existing requirement step | |
| Requirement_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRequirementType?
remoteRequirementType,
) Updates a requirement type in the system | |
| Requirement_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Requirement_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int requirementStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Requirement_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int requirementStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Requirement_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature requirement (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| RemoteRiskImpact | Risk_AddImpact ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskImpact?
remoteRiskImpact,
) Adds a new risk impact to the project template |
| RemoteRiskMitigation | Risk_AddMitigation ( RemoteCredentials?
credentials,
int projectId,
RemoteRiskMitigation?
remoteRiskMitigation,
int?
existingRiskMitigationId,
int?
creatorId,
) Adds a risk mitigation to a risk |
| RemoteRiskProbability | Risk_AddProbability ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskProbability?
remoteRiskProbability,
) Adds a new risk probability to the project template |
| RemoteRiskStatus | Risk_AddStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskStatus?
remoteRiskStatus,
) Adds a new risk status to the project template |
| RemoteRiskType | Risk_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskType?
remoteRiskType,
) Adds a new risk type to the project template |
| long | Risk_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of risks that match the filter. |
| RemoteRisk | Risk_Create ( RemoteCredentials?
credentials,
RemoteRisk?
remoteRisk,
) Creates a new risk in the system |
| RemoteComment | Risk_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a risk. |
| RemoteWorkflow | Risk_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for risks in the specified project template |
| RemoteWorkflowTransition | Risk_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a risk workflow |
| Risk_Delete ( RemoteCredentials?
credentials,
int projectId,
int riskId,
) Deletes a risk in the system | |
| Risk_DeleteMitigation ( RemoteCredentials?
credentials,
int projectId,
int riskId,
int riskMitigationId,
) Deletes a risk mitigation in the list | |
| Risk_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Risk_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| ArrayOfRemoteRisk | Risk_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of risks in the system that match the provided filter/sort |
| RemoteRisk | Risk_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int riskId,
) Retrieves a single risk in the system |
| ArrayOfRemoteComment | Risk_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int RiskId,
) Retrieves comments for a specified risk. |
| ArrayOfRemoteRisk | Risk_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all risks owned by the currently authenticated user |
| ArrayOfRemoteRiskImpact | Risk_RetrieveImpacts ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of risk impacts in the project template |
| RemoteRiskMitigation | Risk_RetrieveMitigationById ( RemoteCredentials?
credentials,
int projectId,
int riskMitigationId,
) Retrieves a single risk mitigation by its ID |
| ArrayOfRemoteRiskMitigation | Risk_RetrieveMitigations ( RemoteCredentials?
credentials,
int projectId,
int riskId,
) Retrieves a list of risk mitigations |
| ArrayOfRemoteRiskProbability | Risk_RetrieveProbabilities ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of risk probabilities in the project template |
| ArrayOfRemoteRiskStatus | Risk_RetrieveStatuses ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of risk statuses in the system |
| ArrayOfRemoteRiskType | Risk_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of risk types in the system |
| RemoteWorkflow | Risk_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Risk_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Risk_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int riskTypeId,
int currentStatusId,
) Retrieves the list of risk custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Risk_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int riskStatusId,
) Retrieves the list of risk fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Risk_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int riskTypeId,
int riskStatusId,
) Retrieves the list of risk fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Risk_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for risks in a given project template |
| ArrayOfRemoteWorkflowTransition | Risk_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given risk status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Risk_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
int currentTypeId,
int currentStatusId,
boolean isCreator,
boolean isOwner,
) Will retrieve available transitions for the specied status ID for the currently logged-on user. |
| Risk_Update ( RemoteCredentials?
credentials,
RemoteRisk?
remoteRisk,
) Updates a risk in the system | |
| Risk_UpdateImpact ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskImpact?
remoteRiskImpact,
) Updates a risk impact in the system | |
| Risk_UpdateMitigation ( RemoteCredentials?
credentials,
int projectId,
RemoteRiskMitigation?
remoteRiskMitigation,
) Updates an existing risk mitigation | |
| Risk_UpdateProbability ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskProbability?
remoteRiskProbability,
) Updates a risk probability in the system | |
| Risk_UpdateStatus ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskStatus?
remoteRiskStatus,
) Updates a risk status in the system | |
| Risk_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteRiskType?
remoteRiskType,
) Updates a risk type in the system | |
| Risk_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Risk_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int riskStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Risk_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int riskStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Risk_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature risk (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| ArrayOfRemoteSavedFilter | SavedFilter_RetrieveForUser ( RemoteCredentials?
credentials,
) Retrieves the list of saved filters for the current user (all projects) |
| SavedFilter_Update ( RemoteCredentials?
credentials,
RemoteSavedFilter?
remoteFilter,
) Updates a list page saved filter which is owned by the modifying user. Only the Name, IsShared, and Entries properties can be updated. Use a int value of -999 for (none) option. This API endpoint will let you create invalid saved filters, and this will throw an error on artifact list pages when applied or always return empty results. It is recommended to primarily use this endpoint to update existing filtered fields (Such as updating a ReleaseId within a saved filter to a new release at the beginning of a sprint) In order to influence which columns are viewable and their order, you should modify filters with property names formatted as "_{FieldName}", and set the StringValue to "Y_0" or "N_0" to declare Yes or No for displaying that property. The 0 should be replaced with numbers which convey the order of displayable fields. The UI uses 1 through X where X is the total number of fields, but it is arbitrary. A lower number makes the column closer to the left on the list page. This can be done alongside a filtered field with a property name formatted as "{FieldName}" for the same field, and the one without the underscore (_) should contain the filter value instead of the display order information. Do not try to put both the "Y_0" and the actual filter value in the same RemoteFilter object (the objects in "Filters") as that will not work. | |
| RemoteProductSourceCodeProvider | SourceCode_AddProductProviderConfig ( RemoteCredentials?
credentials,
int projectId,
RemoteProductSourceCodeProvider?
remoteProvider,
) Adds a source code provider to a product with any desired product level configuration. Leave fields blank to use system configured defaults without exposing to product admins. System admins only. |
| RemoteSystemSourceCodeProvider | SourceCode_CreateProvider ( RemoteCredentials?
credentials,
RemoteSystemSourceCodeProvider?
remoteProvider,
) Creates a new system level source code provider configuration - needs to have at least Name, ConnectionInfo, Login, and Password populated |
| SourceCode_DeleteProvider ( RemoteCredentials?
credentials,
int versionControlSystemId,
) Completely deletes a source code provider from the system. This will hard delete all system and product configurations for this particular provider. | |
| base64Binary | SourceCode_OpenFileById ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
fileId,
string?
revisionId,
) Returns the physical contents of a file in a linked source code repository |
| SourceCode_RemoveProductConfiguration ( RemoteCredentials?
credentials,
int projectId,
) Removes any source code configuration for the specified product | |
| ArrayOfRemoteLinkedArtifact | SourceCode_RetrieveArtifactsForRevision ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
revisionId,
) Retrieves a list of artifacts associated with a specific revision |
| ArrayOfRemoteSourceCodeBranch | SourceCode_RetrieveBranches ( RemoteCredentials?
credentials,
int projectId,
) Retrieves a list of source code branches in the project |
| RemoteSourceCodeConnection | SourceCode_RetrieveConnectionInformation ( RemoteCredentials?
credentials,
int projectId,
) Returns the source code information for a specific product in Spira |
| RemoteSourceCodeFile | SourceCode_RetrieveFileById ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
fileId,
) Retrieves a specific file by its ID |
| ArrayOfRemoteSourceCodeFile | SourceCode_RetrieveFilesByFolder ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
folderId,
) Retrieves a list of files in a specific folder |
| ArrayOfRemoteSourceCodeFile | SourceCode_RetrieveFilesByRevision ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
revisionId,
) Retrieves a list of files contained in a specific revision |
| ArrayOfRemoteSourceCodeFile | SourceCode_RetrieveFilesForArtifact ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
int artifactTypeId,
int artifactId,
) Retrieves a list of files associated with a specific artifact |
| ArrayOfRemoteSourceCodeFolder | SourceCode_RetrieveFoldersByParent ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
parentFolderId,
) Retrieves a list of folders by their parent (unless root) |
| RemoteProductSourceCodeProvider | SourceCode_RetrieveProductProviderConfig ( RemoteCredentials?
credentials,
int projectId,
) Retrieves the currently active provider configuration for a particular product. |
| ArrayOfRemoteProductSourceCodeProvider | SourceCode_RetrieveProductProviderConfigsBySystemId ( RemoteCredentials?
credentials,
int versionControlSystemId,
) Retrieves the list of product configurations for a given provider. System administrators only. |
| RemoteSystemSourceCodeProvider | SourceCode_RetrieveProviderById ( RemoteCredentials?
credentials,
int versionControlSystemId,
) Retrieves a source code system configuration by it's VersionControlSystemId |
| ArrayOfRemoteSystemSourceCodeProvider | SourceCode_RetrieveProviders ( RemoteCredentials?
credentials,
) Retrieves all source code provider system level configurations |
| RemoteSourceCodeRevision | SourceCode_RetrieveRevisionById ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
revisionId,
) Retrieves a revision by its ID |
| ArrayOfRemoteSourceCodeRevision | SourceCode_RetrieveRevisions ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
int startRow,
int numberRows,
RemoteSort?
remoteSort,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves a sorted, filtered, paginated list of revisions in the repository |
| ArrayOfRemoteSourceCodeRevision | SourceCode_RetrieveRevisionsForArtifact ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
int artifactTypeId,
int artifactId,
) Retrieves a list of revisions associated with a specific artifact |
| ArrayOfRemoteSourceCodeRevision | SourceCode_RetrieveRevisionsForFile ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
string?
fileId,
) Retrieves a list of revisions for a specific file |
| boolean | SourceCode_TestProductProviderConfiguration ( RemoteCredentials?
credentials,
int projectId,
) Tests whether the credentials configured for the specified product can make a successful connection / see the configured repository This will use any system level configuration which does not exist at the product level - ex. if ConnectionInfo is not set at the product level, then it will use the system level ConnectionInfo |
| boolean | SourceCode_TestSystemProviderConfiguration ( RemoteCredentials?
credentials,
int versionControlSystemId,
) Returns true if the system level configuration makes a valid connection |
| SourceCode_UpdateProductProviderConfig ( RemoteCredentials?
credentials,
int projectId,
RemoteProductSourceCodeProvider?
remoteProvider,
) Overwrites a provider's configuration for a given product - even for fields which are omitted, except for VersionControlSystemId and ProjectId. This endpoint will only modify the currently active system. | |
| SourceCode_UpdateProvider ( RemoteCredentials?
credentials,
RemoteSystemSourceCodeProvider?
remoteProvider,
) Overwrites a system level provider which already exists - needs to have at least Name, ConnectionInfo, Login, and Password populated. Will overwrite every field, even if left blank or omitted. | |
| long | SourceCodeRevisions_Count ( RemoteCredentials?
credentials,
int projectId,
string?
branchId,
) Returns the total number of Revisions/Commits in a specific branch |
| ArrayOfRemoteArtifactSubscription | Subscription_RetrieveForArtifact ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
) Retrieves a list of all the users subscribed to an artifact |
| ArrayOfRemoteArtifactSubscription | Subscription_RetrieveForUser ( RemoteCredentials?
credentials,
) Retrieves a list of all the items the current user is subscribed to (all projects) |
| Subscription_SubscribeToArtifact ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
) Subscribes to a specified artifact | |
| Subscription_UnsubscribeFromArtifact ( RemoteCredentials?
credentials,
int projectId,
int artifactTypeId,
int artifactId,
) Unsubscribes from a specified artifact | |
| 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 ( RemoteCredentials?
credentials,
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 ( RemoteCredentials?
credentials,
) 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 |
| System_ProcessNotifications Executes any scheduled notification events | |
| ArrayOfRemoteEvent2 | System_RetrieveEvents ( RemoteCredentials?
credentials,
int startingRow,
int numberOfRows,
RemoteSort?
remoteSort,
ArrayOfRemoteFilter?
remoteFilters,
) Retrieves a filtered list of event logs from across the system |
| ArrayOfRemoteSystemCustomListValue | SystemCustomProperty_AddCustomListValues ( RemoteCredentials?
credentials,
int customListId,
ArrayOfRemoteSystemCustomListValue?
remoteListValues,
) Adds a custom list value to a specified custom list |
| RemoteSystemCustomProperty | SystemCustomProperty_Create ( RemoteCredentials?
credentials,
int artifactTypeId,
int?
customListId,
RemoteSystemCustomProperty?
remoteCustomProperty,
) |
| RemoteSystemCustomList | SystemCustomProperty_CreateCustomList ( RemoteCredentials?
credentials,
RemoteSystemCustomList?
remoteCustomList,
) |
| SystemCustomProperty_Delete ( RemoteCredentials?
credentials,
int artifactTypeId,
int propertyNumber,
) Deletes a system custom property by it's ID | |
| SystemCustomProperty_DeleteCustomList ( RemoteCredentials?
credentials,
int customListId,
) Deletes a system custom list from the database | |
| SystemCustomProperty_RemoveCustomListValue ( RemoteCredentials?
credentials,
int customListValueId,
) Deletes a system custom list value | |
| RemoteSystemCustomList | SystemCustomProperty_RetrieveCustomListById ( RemoteCredentials?
credentials,
int customListId,
) Retrieves a system custom list by its ID, including any custom list values |
| ArrayOfRemoteSystemCustomList | SystemCustomProperty_RetrieveCustomLists ( RemoteCredentials?
credentials,
) Retrieves all the active system custom lists in the system |
| ArrayOfRemoteSystemCustomProperty | SystemCustomProperty_RetrieveForArtifactType ( RemoteCredentials?
credentials,
int artifactTypeId,
boolean includeDeleted,
) Retrieves the list of system custom properties configured for the specified artifact type |
| SystemCustomProperty_Update ( RemoteCredentials?
credentials,
RemoteSystemCustomProperty?
remoteCustomProperty,
) Creates a new system custom property | |
| SystemCustomProperty_UpdateCustomList ( RemoteCredentials?
credentials,
RemoteSystemCustomList?
remoteCustomList,
) Updates a system custom list's name, active status, and/or sort option (SortedOnValue = true sorts alphabetically, SortedOnValue = false sorts by ID) | |
| RemoteTaskPriority | Task_AddPriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTaskPriority?
remoteTaskPriority,
) Adds a new task priority to the project template |
| RemoteTaskType | Task_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTaskType?
remoteTaskType,
) Adds a new task type to the project template |
| long | Task_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of tasks that match the filter. |
| RemoteTask | Task_Create ( RemoteCredentials?
credentials,
RemoteTask?
remoteTask,
) Creates a new task in the system |
| RemoteComment | Task_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a task. |
| RemoteTaskFolder | Task_CreateFolder ( RemoteCredentials?
credentials,
RemoteTaskFolder?
remoteTaskFolder,
) Creates a new task folder in the system |
| RemoteWorkflow | Task_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for tasks in the specified project template |
| RemoteWorkflowTransition | Task_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a task workflow |
| Task_Delete ( RemoteCredentials?
credentials,
int projectId,
int taskId,
) Deletes a task in the system | |
| Task_DeleteFolder ( RemoteCredentials?
credentials,
int projectId,
int taskFolderId,
) Deletes a task folder in the system | |
| Task_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| Task_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| ArrayOfRemoteTask | Task_Retrieve ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int taskId,
) Retrieves a single task in the system |
| ArrayOfRemoteComment | Task_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int TaskId,
) Retrieves comments for a specified task. |
| RemoteTaskFolder | Task_RetrieveFolderById ( RemoteCredentials?
credentials,
int projectId,
int taskFolderId,
) Retrieves a single test folder in the system |
| ArrayOfRemoteTaskFolder | Task_RetrieveFolders ( RemoteCredentials?
credentials,
int projectId,
) Retrieves all of the task folders in the project with their hierarchy |
| ArrayOfRemoteTaskFolder | Task_RetrieveFoldersByParent ( RemoteCredentials?
credentials,
int projectId,
int?
parentTaskFolderId,
) Retrieves a list of folders by the parent folder |
| ArrayOfRemoteTask | Task_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all tasks owned by the currently authenticated user |
| ArrayOfRemoteTask | Task_RetrieveNew ( RemoteCredentials?
credentials,
int projectId,
dateTime creationDate,
int startRow,
int numberOfRows,
) Retrieves all new tasks added in the system since the date specified |
| ArrayOfRemoteTaskPriority | Task_RetrievePriorities ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of task priorities in the project template |
| ArrayOfRemoteTaskStatus | Task_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves the list of task statuses in the system |
| ArrayOfRemoteTaskType | Task_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of task types in the system |
| RemoteWorkflow | Task_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | Task_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | Task_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int taskTypeId,
int currentStatusId,
) Retrieves the list of task custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | Task_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int taskStatusId,
) Retrieves the list of task fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | Task_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int taskTypeId,
int taskStatusId,
) Retrieves the list of task fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | Task_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for tasks in a given project template |
| ArrayOfRemoteWorkflowTransition | Task_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given task status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | Task_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
RemoteTask?
remoteTask,
) Updates a task in the system | |
| Task_UpdateFolder ( RemoteCredentials?
credentials,
RemoteTaskFolder?
remoteTaskFolder,
) Updates a test folder in the system | |
| Task_UpdatePriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTaskPriority?
remoteTaskPriority,
) Updates a task priority in the system | |
| Task_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTaskType?
remoteTaskType,
) Updates a task type in the system | |
| Task_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| Task_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int taskStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| Task_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int taskStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| Task_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature task (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| int | TestCase_AddLink ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
RemoteTestCaseParameter?
remoteTestCaseParameter,
) Adds a new parameter for a test case |
| RemoteTestCasePriority | TestCase_AddPriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTestCasePriority?
remoteTestCasePriority,
) Adds a new test case priority to the project template |
| RemoteTestStep | TestCase_AddStep ( RemoteCredentials?
credentials,
RemoteTestStep?
remoteTestStep,
int testCaseId,
) Adds a new test step to the specified test case |
| TestCase_AddStepParameters ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int testStepId,
ArrayOfRemoteTestStepParameter?
testStepParameters,
) Adds new parameters with provided names and values for a test link step | |
| RemoteTestCaseType | TestCase_AddType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTestCaseType?
remoteTestCaseType,
) Adds a new test case typ to the project template |
| TestCase_AddUpdateAutomationScript ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int?
automationEngineId,
string?
urlOrFilename,
string?
description,
base64Binary?
binaryData,
string?
version,
int?
documentTypeId,
int?
projectAttachmentFolderId,
) Adds or updates the automation test script associated with a test case | |
| long | TestCase_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
int?
incidentId,
) Returns the number of test cases that match the filter. |
| long | TestCase_CountForFolder ( RemoteCredentials?
credentials,
int projectId,
int?
testCaseFolderId,
ArrayOfRemoteFilter?
remoteFilters,
int?
incidentId,
) Gives a count of items within the given folder that match the filters. |
| RemoteTestCase | TestCase_Create ( RemoteCredentials?
credentials,
RemoteTestCase?
remoteTestCase,
) Creates a new test case in the system |
| RemoteComment | TestCase_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a test case. |
| RemoteTestCaseFolder | TestCase_CreateFolder ( RemoteCredentials?
credentials,
RemoteTestCaseFolder?
remoteTestCaseFolder,
) 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 |
| RemoteWorkflow | TestCase_CreateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteWorkflow?
remoteWorkflow,
) Creates a new blank workflow for testCases in the specified project template |
| RemoteWorkflowTransition | TestCase_CreateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Creates a new workflow transition for a testCase workflow |
| TestCase_Delete ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Deletes a test case in the system | |
| TestCase_DeleteFolder ( RemoteCredentials?
credentials,
int projectId,
int testCaseFolderId,
) Deletes a test case folder in the system | |
| TestCase_DeleteParameter ( RemoteCredentials?
credentials,
int projectId,
RemoteTestCaseParameter?
remoteTestCaseParameter,
) Deletes an existing parameter for a test case | |
| TestCase_DeleteStep ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int testStepId,
) Deletes a test step in the system | |
| TestCase_DeleteStepParameters ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int testStepId,
ArrayOfRemoteTestStepParameter?
testStepParameters,
) Deletes existing parameters with provided names and values for a test link step | |
| TestCase_DeleteWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Deletes a workflow from a project template | |
| TestCase_DeleteWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateid,
int workflowId,
int workflowTransitionId,
) Deletes a workflow transition | |
| TestCase_Move ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int?
testCaseFolderId,
) Moves a test case to another location in the hierarchy | |
| TestCase_MoveStep ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int sourceTestStepId,
int?
destinationTestStepId,
) Moves a test step to a different position in the test case | |
| ArrayOfRemoteTestCase | TestCase_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
int?
incidentId,
) Retrieves a list of testCases in the project (all folders) that match the provided filter |
| ArrayOfRemoteTestCase | TestCase_RetrieveByFolder ( RemoteCredentials?
credentials,
int projectId,
int?
testCaseFolderId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
int?
incidentId,
) Retrieves a list of testCases in the project (all folders) that match the provided filter |
| RemoteTestCase | TestCase_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Retrieves a single test case in the system |
| ArrayOfRemoteTestCase | TestCase_RetrieveByTestSetId ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Retrieves all the test cases that are part of a test set |
| ArrayOfRemoteComment | TestCase_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int TestCaseId,
) Retrieves comments for a specified test case. |
| RemoteTestCaseFolder | TestCase_RetrieveFolderById ( RemoteCredentials?
credentials,
int projectId,
int testCaseFolderId,
) Retrieves a single test folder in the system |
| ArrayOfRemoteTestCaseFolder | TestCase_RetrieveFolders ( RemoteCredentials?
credentials,
int projectId,
) Retrieves all of the test case folders in the project with their hierarchy |
| ArrayOfRemoteTestCaseFolder | TestCase_RetrieveFoldersByParent ( RemoteCredentials?
credentials,
int projectId,
int?
parentTestCaseFolderId,
int?
incidentId,
) Retrieves a list of folders by the parent folder |
| ArrayOfRemoteTestCase | TestCase_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all testCases owned by the currently authenticated user |
| ArrayOfRemoteTestCaseParameter | TestCase_RetrieveParameters ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Retrieves the list of defined parameters for a test case along with the associated default value |
| ArrayOfRemoteTestCasePriority | TestCase_RetrievePriorities ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of testCase priorities in the project template |
| ArrayOfRemoteRequirementTestCaseMapping | TestCase_RetrieveRequirementCoverage ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Retrieves the list of requirements associated with a test case |
| ArrayOfRemoteTestCaseStatus | TestCase_RetrieveStatuses ( RemoteCredentials?
credentials,
) Retrieves the list of testCase statuses in the system |
| RemoteTestStep | TestCase_RetrieveStepById ( RemoteCredentials?
credentials,
int projectId,
int testStepId,
) Retrieves a single test step by its ID |
| ArrayOfRemoteTestStepParameter | TestCase_RetrieveStepParameters ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int testStepId,
) Retrieves the list of parameters and provided values for a test link step |
| ArrayOfRemoteTestStep | TestCase_RetrieveSteps ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Retrieves the list of test steps for a test case |
| ArrayOfRemoteTestCaseType | TestCase_RetrieveTypes ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves the list of testCase types in the system |
| RemoteWorkflow | TestCase_RetrieveWorkflowById ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
) Retrieves a single workflow object by its ID |
| ArrayOfRemoteWorkflowCustomProperty | TestCase_RetrieveWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all workflow custom property objects for a specified workflow and artifact status |
| ArrayOfRemoteWorkflowCustomProperty | TestCase_RetrieveWorkflowCustomPropertiesByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int testCaseTypeId,
int currentStatusId,
) Retrieves the list of testCase custom properties and their workflow state for a given type and status/step. |
| ArrayOfRemoteWorkflowField | TestCase_RetrieveWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int testCaseStatusId,
) Retrieves the list of testCase fields and their workflow status for a given workflow and status. |
| ArrayOfRemoteWorkflowField | TestCase_RetrieveWorkflowFieldsByType ( RemoteCredentials?
credentials,
int projectTemplateId,
int testCaseTypeId,
int testCaseStatusId,
) Retrieves the list of testCase fields and their workflow status for a given type and status/step. |
| ArrayOfRemoteWorkflow | TestCase_RetrieveWorkflows ( RemoteCredentials?
credentials,
int projectTemplateId,
) Retrieves all workflows for testCases in a given project template |
| ArrayOfRemoteWorkflowTransition | TestCase_RetrieveWorkflowTransitions ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int currentStatusId,
) Retrieves all transitions from a given testCase status in a specified workflow (Template Admin Only) |
| ArrayOfRemoteWorkflowTransition | TestCase_RetrieveWorkflowTransitionsForUser ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
RemoteTestCase?
remoteTestCase,
) Updates a test case in the system together with its test steps (if populated) | |
| TestCase_UpdateFolder ( RemoteCredentials?
credentials,
RemoteTestCaseFolder?
remoteTestCaseFolder,
) Updates a test folder in the system | |
| TestCase_UpdateParameter ( RemoteCredentials?
credentials,
int projectId,
RemoteTestCaseParameter?
remoteTestCaseParameter,
) Updates an existing parameter for a test case | |
| TestCase_UpdatePriority ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTestCasePriority?
remoteTestCasePriority,
) Updates a test case priority in the system | |
| TestCase_UpdateStep ( RemoteCredentials?
credentials,
RemoteTestStep?
remoteTestStep,
) Updates a single test step in the system | |
| TestCase_UpdateStepParameters ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
int testStepId,
ArrayOfRemoteTestStepParameter?
testStepParameters,
) Updates existing parameters with provided names and values for a test link step | |
| TestCase_UpdateType ( RemoteCredentials?
credentials,
int projectTemplateId,
RemoteTestCaseType?
remoteTestCaseType,
) Updates a test case type in the system | |
| TestCase_UpdateWorkflow ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
RemoteWorkflow?
remoteWorkflow,
) Updates a single workflow object | |
| TestCase_UpdateWorkflowCustomProperties ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int testCaseStatusId,
ArrayOfRemoteWorkflowCustomProperty?
remoteWorkflowCustomProperties,
) Updates workflow custom property states | |
| TestCase_UpdateWorkflowFields ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int testCaseStatusId,
ArrayOfRemoteWorkflowField?
remoteWorkflowFields,
) Updates workflow field states for a given artifact status id in a given workflow | |
| TestCase_UpdateWorkflowTransition ( RemoteCredentials?
credentials,
int projectTemplateId,
int workflowId,
int workflowTransitionId,
RemoteWorkflowTransition?
remoteWorkflowTransition,
) Updates a workflow transition's name, exeuction user roles, or signature testCase (Cannot update the Input / Output StatusId's, create a new transition for that) | |
| RemoteTestConfigurationSet | TestConfiguration_RetrieveForTestSet ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Retrieves the test configuration set associated with the given test set, or NULL if none associated |
| RemoteTestConfigurationSet | TestConfiguration_RetrieveSetById ( RemoteCredentials?
credentials,
int projectId,
int testConfigurationSetId,
) Retrieves the test configuration set by its id |
| ArrayOfRemoteTestConfigurationSet | TestConfiguration_RetrieveSets ( RemoteCredentials?
credentials,
int projectId,
) Retrieves the list of test configuration sets in the current project (without the detailed entries) |
| long | TestRun_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
) Returns the number of test runs that match the filter. |
| ArrayOfRemoteAutomatedTestRun | TestRun_CreateForAutomatedTestSet ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
ArrayOfint?
testCaseIds,
int?
incidentId,
) Creates a new test run shell from the provided test case(s) |
| ArrayOfRemoteManualTestRun | TestRun_CreateFromTestSet ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Creates a new test run shell from the provided test set |
| TestRun_Delete ( RemoteCredentials?
credentials,
int projectId,
int testRunId,
) Deletes a test run from the system | |
| RemoteAutomatedTestRun | TestRun_RecordAutomated1 ( RemoteCredentials?
credentials,
RemoteAutomatedTestRun?
remoteTestRun,
) Records the results of executing an automated test |
| int | TestRun_RecordAutomated2 ( string?
userName,
string?
password,
int projectId,
int?
testerUserId,
int testCaseId,
int?
incidentId,
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 ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteAutomatedTestRun?
remoteTestRuns,
) Records the results of executing multiple automated tests |
| ArrayOfRemoteTestRun | TestRun_Retrieve ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int testRunId,
) Retrieves a single automated test run in the system including the automation-specific information |
| RemoteTestRun | TestRun_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
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 |
| ArrayOfRemoteTestRun | TestRun_RetrieveByTestCaseId ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of test runs for a specific test case |
| ArrayOfRemoteManualTestRun | TestRun_RetrieveManual ( RemoteCredentials?
credentials,
int projectId,
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 ( RemoteCredentials?
credentials,
int projectId,
int testRunId,
) Retrieves a single manual test run in the system including any associated steps |
| ArrayOfRemoteManualTestRun | TestRun_Save ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteManualTestRun?
remoteTestRuns,
dateTime?
endDate,
) Saves set of test runs, each containing test run steps |
| TestSet_AddParameter ( RemoteCredentials?
credentials,
int projectId,
RemoteTestSetParameter?
remoteTestSetParameter,
) Adds a new parameter for a test set | |
| TestSet_AddTestCaseParameter ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
RemoteTestSetTestCaseParameter?
remoteTestSetTestCaseParameter,
) Adds a new test parameter specified by a specific test set's test case (the paramater is only added if it is not already set) | |
| ArrayOfRemoteTestSetTestCaseMapping | TestSet_AddTestMapping ( RemoteCredentials?
credentials,
int projectId,
RemoteTestSetTestCaseMapping?
remoteTestSetTestCaseMapping,
int?
existingTestSetTestCaseId,
ArrayOfRemoteTestSetTestCaseParameter?
parameters,
dateTime?
plannedDate,
) Maps a test set to a test case, so that the test case is part of the test set |
| boolean | TestSet_CheckInUseStatus ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
int testSetTestCaseId,
) Checks to see if a specific test case in a test set is either in use or available for automated execution |
| long | TestSet_Count ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
int?
incidentId,
) Returns the number of test sets that match the filter. |
| long | TestSet_CountForFolder ( RemoteCredentials?
credentials,
int projectId,
int?
testSetFolderId,
ArrayOfRemoteFilter?
remoteFilters,
int?
incidentId,
) Gives a count of items within the given folder that match the filters. |
| RemoteTestSet | TestSet_Create ( RemoteCredentials?
credentials,
RemoteTestSet?
remoteTestSet,
) Creates a new test set in the system |
| RemoteComment | TestSet_CreateComment ( RemoteCredentials?
credentials,
int projectId,
RemoteComment?
remoteComment,
) Creates a new comment for a test set. |
| RemoteTestSetFolder | TestSet_CreateFolder ( RemoteCredentials?
credentials,
RemoteTestSetFolder?
remoteTestSetFolder,
) Creates a new test set folder in the system |
| TestSet_Delete ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Deletes a test set / folder in the system | |
| TestSet_DeleteFolder ( RemoteCredentials?
credentials,
int projectId,
int testSetFolderId,
) Deletes a test set folder in the system | |
| TestSet_DeleteParameter ( RemoteCredentials?
credentials,
int projectId,
RemoteTestSetParameter?
remoteTestSetParameter,
) Deletes an existing parameter for a test set | |
| TestSet_DeleteTestCaseParameter ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
RemoteTestSetTestCaseParameter?
remoteTestSetTestCaseParameter,
) Deletes an existing test parameter specified by a specific test set's test case | |
| TestSet_Move ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
int?
destinationTestSetId,
) Moves a test set to another location in the hierarchy | |
| TestSet_RemoveTestMapping ( RemoteCredentials?
credentials,
int projectId,
RemoteTestSetTestCaseMapping?
remoteTestSetTestCaseMapping,
) Removes a test case from a test set | |
| ArrayOfRemoteTestSet | TestSet_Retrieve ( RemoteCredentials?
credentials,
int projectId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
int?
incidentId,
) Retrieves a list of testSets in the project (all folders) that match the provided filter |
| ArrayOfRemoteTestSet | TestSet_RetrieveByFolder ( RemoteCredentials?
credentials,
int projectId,
int?
testSetFolderId,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
int?
incidentId,
) Retrieves a list of testSets in the project (all folders) that match the provided filter |
| RemoteTestSet | TestSet_RetrieveById ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Retrieves a single test set/folder in the system |
| ArrayOfRemoteTestSet | TestSet_RetrieveByTestCaseId ( RemoteCredentials?
credentials,
int projectId,
int testCaseId,
) Retrieves all (Up to 500) Test Sets which contain the provided test case ID |
| ArrayOfRemoteComment | TestSet_RetrieveComments ( RemoteCredentials?
credentials,
int projectId,
int TestSetId,
) Retrieves comments for a specified test set. |
| RemoteTestSetFolder | TestSet_RetrieveFolderById ( RemoteCredentials?
credentials,
int projectId,
int testSetFolderId,
) Retrieves a single test folder in the system |
| ArrayOfRemoteTestSetFolder | TestSet_RetrieveFolders ( RemoteCredentials?
credentials,
int projectId,
) Retrieves all of the test set folders in the project with their hierarchy |
| ArrayOfRemoteTestSetFolder | TestSet_RetrieveFoldersByParent ( RemoteCredentials?
credentials,
int projectId,
int?
parentTestSetFolderId,
int?
incidentId,
) Retrieves a list of folders by the parent folder |
| ArrayOfRemoteTestSet | TestSet_RetrieveForOwner ( RemoteCredentials?
credentials,
) Retrieves all testSets owned by the currently authenticated user |
| ArrayOfRemoteTestSetParameter | TestSet_RetrieveParameters ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Retrieves a list of test parameter values specified by a specific test set |
| ArrayOfRemoteTestSetTestCaseMapping | TestSet_RetrieveTestCaseMapping ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
) Retrieves all the test cases that are part of a test set |
| ArrayOfRemoteTestSetTestCaseParameter | TestSet_RetrieveTestCaseParameters ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
int testSetTestCaseId,
) Retrieves a list of test parameter values specified by a specific test set's test case instance |
| TestSet_SetInUseStatus ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
int testSetTestCaseId,
boolean isInUse,
) Marks a specific test case in a test set as being either in use or available for automated execution | |
| TestSet_Update ( RemoteCredentials?
credentials,
RemoteTestSet?
remoteTestSet,
) Updates a test set in the system | |
| TestSet_UpdateFolder ( RemoteCredentials?
credentials,
RemoteTestSetFolder?
remoteTestSetFolder,
) Updates a test folder in the system | |
| TestSet_UpdateParameter ( RemoteCredentials?
credentials,
int projectId,
RemoteTestSetParameter?
remoteTestSetParameter,
) Updates an existing parameter for a test set | |
| TestSet_UpdateTestCaseMapping ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
RemoteTestSetTestCaseMapping?
remoteTestSetTestCaseMapping,
) Updates a test set test case mapping's properties (not the mapping itself) | |
| TestSet_UpdateTestCaseParameter ( RemoteCredentials?
credentials,
int projectId,
int testSetId,
RemoteTestSetTestCaseParameter?
remoteTestSetTestCaseParameter,
) Updates an existing test parameter specified by a specific test set's test case | |
| ArrayOfRemoteRequirementTestStepMapping | TestStep_RetrieveRequirementCoverage ( RemoteCredentials?
credentials,
int projectId,
int testStepId,
) Retrieves a list of the requirement ids mapped against a specific test step |
| RemoteTimesheet | Timesheet_Create ( RemoteCredentials?
credentials,
RemoteTimesheet?
remoteTimesheet,
dateTime timesheetDate,
) Creates a new timesheet in the system |
| Timesheet_Delete ( RemoteCredentials?
credentials,
string?
timesheetId,
) Deletes a timesheet in the system | |
| ArrayOfRemoteTimesheet | Timesheet_Retrieve ( RemoteCredentials?
credentials,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of timesheets in the system that match the provided filter/sort. If a user lacks permissions to view other users timesheets, a filter of the authenticated user ID will be applied. This does not apply timezone offsets to filters, so all times are expected in UTC. This is to support filtering by start/end date being more straightforward, given these dates do not have a time. |
| RemoteTimesheet | Timesheet_RetrieveById ( RemoteCredentials?
credentials,
int timesheetId,
) Retrieves a single timesheet in the system |
| Timesheet_Update ( RemoteCredentials?
credentials,
RemoteTimesheet?
remoteTimesheet,
) Updates a timesheet in the system | |
| RemoteTimesheetEntry | TimesheetEntry_Create ( RemoteCredentials?
credentials,
RemoteTimesheetEntry?
remoteTimesheetEntry,
) Creates a new timesheet entry in the system |
| TimesheetEntry_Delete ( RemoteCredentials?
credentials,
string?
timesheetEntryId,
) Deletes a timesheet entry in the system | |
| ArrayOfRemoteTimesheetEntry | TimesheetEntry_Retrieve ( RemoteCredentials?
credentials,
ArrayOfRemoteFilter?
remoteFilters,
RemoteSort?
remoteSort,
int startingRow,
int numberOfRows,
) Retrieves a list of timesheet entries in the system that match the provided filter/sort |
| ArrayOfRemoteTimesheetEntry | TimesheetEntry_RetrieveByTimesheet ( RemoteCredentials?
credentials,
int timesheet_id,
) Retrieves a list of timesheet entries which belong to a given timesheet ID |
| TimesheetEntry_Update ( RemoteCredentials?
credentials,
RemoteTimesheetEntry?
remoteTimesheetEntry,
) Updates a timesheet entry in the system | |
| ArrayOfRemoteTimesheetStatus | TimesheetStatus_Retrieve ( RemoteCredentials?
credentials,
boolean activeOnly,
) Retrieves a list of timesheet statuses in the system |
| User_AddContact ( RemoteCredentials?
credentials,
int userId,
) Adds a user as a contact | |
| RemoteUser | User_Create ( RemoteCredentials?
credentials,
RemoteUser?
remoteUser,
string?
password,
string?
passwordQuestion,
string?
passwordAnswer,
int?
projectId,
int?
projectRoleId,
) Creates a new user in the system and adds them to the current project as the specified role |
| User_Delete ( RemoteCredentials?
credentials,
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 ( RemoteCredentials?
credentials,
int userId,
) Removes a user as a contact | |
| ArrayOfRemoteUser | User_Retrieve ( RemoteCredentials?
credentials,
boolean includeInactive,
int startingRow,
int numberOfRows,
) Retrieves a list of all the users in the system (all projects) |
| RemoteUser | User_RetrieveById ( RemoteCredentials?
credentials,
int userId,
) Retrieves a single user in the system |
| RemoteUser | User_RetrieveByUserName ( RemoteCredentials?
credentials,
string?
userName,
boolean includeInactive,
) Retrieves a single user in the system by user-name |
| ArrayOfRemoteUser | User_RetrieveContacts ( RemoteCredentials?
credentials,
) Retrieves the list of contacts for the current user |
| User_Update ( RemoteCredentials?
credentials,
RemoteUser?
remoteUser,
) Updates an existing user in the system |