Table of Contents
Table of Contents
If you have any problems with the software or documentation, please contact Viewtier Technical Support via online support forums, electronic mail, fax, or as described below. For information regarding other support information, click the Support link on the Viewtier web site atwww.viewtier.com.
650-240-4455
Parabuild web service WSDL can be found at:
<Parabuild installation directory>/bin/wsdl/Parabuild.wsdl.
Parabuild web service is available at:
http://<parabuild host>:8080/parabuild/integration/webservice/Parabuild
Table of Contents
/**
* Returns server version.
*
* @return a string containing server version.
*/
String serverVersion();
/**
* Returns a list of global system properties.
*
* @return a list of global system properties.
*/
SystemProperty[] getSystemProperties();
/**
* Returns a global version control user to email map.
*
* @return a global version control user to email map.
*/
GlobalVCSUserMap[] getGlobalVcsUserMap();
/**
* Returns a list of projects.
*
* @return a list of projects.
*/
Project[] getProjects();
/**
* Returns a list of project attributes.
*
* @param projectID project ID
*
* @return a list of project attributes.
*/
ProjectAttribute[] getProjectAttributes(int projectID);
/**
* Returns a list of build configurations belonging to a project.
*
* @param projectID project ID
*
* @return a list of build configurations belonging to a project.
*/
ProjectBuild[] getProjectBuilds(int projectID);
/**
* Returns a list of display groups.
*
* @return a list of display groups.
*/
DisplayGroup[] getDisplayGroups();
/**
* Returns a list of build configurations are that part of a display group.
*
* @param displayGroupID display group ID
*
* @return a list of build configurations are that part of a display group.
*/
DisplayGroupBuild[] getDisplayGroupBuilds(int displayGroupID);
This section enumerates methods available for accessing information about build farms and build agents.
/**
* Returns a list of build farm configurations.
*
* @return a list of build farm configurations.
*/
BuildFarmConfiguration[] getBuildFarmConfigurations();
/**
* Returns a list of attributes of a build farm.
*
* This method is added for future compatibility. The current implementation returns an empty array.
*
* @param buildFarmID build farm ID
* @return a list of attributes of a build farm.
*/
BuildFarmConfigurationAttribute[] getBuildFarmConfigurationAttributes(int buildFarmID);
/**
* Returns a list of agents belonging to a build farm.
*
* @param buildFarmID build farm ID
* @return a list of build agents belonging to a build farm.
*/
BuildFarmAgent[] getBuildFarmAgents(int buildFarmID);
/**
* Returns a list agent configurations.
*
* @return a list agent configurations.
*/
AgentConfiguration[] getAgentConfigurations();
This section enumerates method for querying information related to build configuration.
/**
* Returns a list of active build configurations.
*
* @return a list of active build configurations.
*/
BuildConfiguration[] getActiveBuildConfigurations();
/**
* Returns a list of attributes for a build configuration.
*
* @param buildID build ID.
* @return a list of attributes for a build configuration.
*/
BuildConfigurationAttribute[] getBuildConfigurationAttributes(int buildID);
/**
* Returns a list of version control settings.
*
* @param buildID build ID
* @return a list of version control settings.
*/
VersionControlSetting[] getVersionControlSettings(int buildID);
/**
* Returns a list of schedule properties.
*
* @param buildID build ID
* @return a list of schedule properties.
*/
ScheduleProperty[] getScheduleProperties(int buildID);
/**
* Returns a list of label properties.
*
* @param buildID build ID
* @return a list of label properties.
*/
LabelProperty[] getLabelProperties(int buildID);
/**
* Returns a list of log configurations.
*
* @param buildID build ID
* @return a list of log configurations.
*/
LogConfiguration[] getLogConfigurations(int buildID);
/**
* Returns a list of log configuration properties.
*
* @param logID log ID
* @return a list of log configuration properties.
*/
LogConfigurationProperty[] getLogConfigurationProperties(int logID);
/**
* Returns a list of version control user to email maps.
*
* @param buildID build ID
* @return a list of version control use to email maps.
*/
VCSUserToEmailMap[] getVCSUserToEmailMap(int buildID);
/**
* Returns a list of build watchers.
*
* @param buildID a list of build watchers.
* @return a list of build watchers.
*/
BuildWatcher[] getBuildWatchers(int buildID);
/**
* Returns a list of build steps.
*
* @param buildID build ID
* @return a list of build steps.
*/
BuildSequence[] getBuildSequence(int buildID);
/**
* Returns a list of schedule items
*
* @param buildID build ID
* @return Returns a list of schedule items
*/
ScheduleItem[] getScheduleItem(int buildID);
/**
* Returns a list of issues trackers.
*
* @param buildID build ID
*
* @return a list of issues trackers.
*/
IssueTracker[] getIssueTracker(int buildID);
/**
* Returns a list of issue tracker properties.
*
* @param issueTrackerID issue tracker ID
*
* @return a list of issue tracker properties.
*/
IssueTrackerProperty[] getIssueTrackerProperties(int issueTrackerID);
This section enumerates methods for accessing build results.
/**
* Returns number of build runs for the given build configuration.
*
* @param activeBuildID build ID
* @return number of build runs for the given build configuration.
*/
int getBuildRunCount(int activeBuildID);
/**
* Returns build run for the given build run ID.
*
* @param buildRunID build run ID
* @return build run.
*/
BuildRun getBuildRun(int buildRunID);
/**
* Returns a list of completed build runs.
*
* @param activeBuildID build ID
* @param firstResult number from that to start listing build runs.
* @param maxCount number of build runs to retrieve.
* @return a list of completed build runs.
*/
BuildRun[] getCompletedBuildRuns(final int activeBuildID, final int firstResult, final int
maxCount);
/**
* Returns the last successful build run.
*
* @param activeBuildID build ID
* @return the last successful build run or null if there is no any.
*/
BuildRun getLastSuccessfulBuildRun(int activeBuildID);
/**
* Returns an array of last successful BuildRuns that match given display group ID and change list number.
*
* @param displayGroupID display group ID
* @param changeListNumber change list number
* @return array of last successful BuildRuns that matche given display group ID and change list number or an empty array if no matching builds exist.
*/
public BuildRun[] findlLastSuccessfulBuildRuns(final int displayGroupID, final int changeListNumber);
/**
* Returns a list of build run attributes.
*
* @param buildRunID build run ID
* @return list of build run attributes.
*/
BuildRunAttribute[] getBuildRunAttributes(int buildRunID);
/**
* Returns change lists that participated in the given build run.
*
* @param buildRunID build run ID.
* @return change lists that participated in the given build run.
*/
ChangeList[] getBuildRunParticipants(int buildRunID);
/**
* Returns a list of changes in the given change list.
*
* @param changeListID change list ID
* @return a list of changes in the given change list.
* @see #getBuildRunParticipants(int)
* @see #getChangeList(int)
*/
Change[] getChanges(int changeListID);
/**
* Returns a list of build step runs.
*
* @param buildRunID build run ID
* @return a list of step runs.
*/
StepRun[] getStepRuns(int buildRunID);
/**
* Returns a list of build step run attributes.
*
* @param stepRunID step run ID
* @return a list of step run attributes.
* @see #getStepRuns(int)
*/
StepRunAttribute[] getStepRunRunAttributes(int stepRunID);
/**
* Returns a list of build step logs.
*
* @param stepRunID step run ID
* @return a list of build step logs.
*/
StepLog[] getStepLogs(int stepRunID);
/**
* Returns a list of build step results.
*
* @param stepRunID step run ID
* @return a list of build step results.
*/
StepResult[] getStepResults(int stepRunID);
/**
* Returns a change list.
*
* @param changeListID change list ID
* @return a change list.
*/
ChangeList getChangeList(int changeListID);
/**
* Returns a list of release notes.
*
* @param buildRunID build run ID
* @return a list of release notes.
*/
ReleaseNote[] getReleaseNotes(int buildRunID);
/**
* Returns an issue.
*
* @param issueID an issue ID.
* @return an issue.
*/
Issue getIssue(int issueID);
/**
* Returns a list of issue attributes.
*
* @param issueID issue ID.
*
* @return a list of issue attributes.
*/
IssueAttribute[] getIssueAttributes(int issueID);
/**
* Returns a list of issue change lists.
*
* @param issueID issue ID.
*
* @return a list of issue change lists.
*/
IssueChangeList[] getIssueChangeLists(int issueID);
/**
* Returns a list of result groups.
*
* @return list of result groups.
*/
ResultGroup[] getResultGroups();
/**
* Returns a list of project result groups.
*
* @param projectID project ID
* @return a list of project result groups.
*/
ProjectResultGroup[] getProjectResultGroups(int projectID);
/**
* Returns a list of result configurations.
*
* @param buildID build ID
* @return a list of result configurations.
*/
ResultConfiguration[] getResultConfigurations(int buildID);
/**
* Returns a list of result configuration properties.
*
* @param resultConfigID result configuration ID
*
* @return a list of result configuration properties.
*/
ResultConfigurationProperty[] getResultConfigurationProperties(int resultConfigID);
/**
* Returns a list published build step results.
*
* @param resultGroupID result group ID
*
* @return a list published build step results.
*/
PublishedStepResult[] getPublishedStepResults(int resultGroupID);
/**
* Returns a list of build runs actions.
*
* @param buildRunID
*
* @return a list of build runs actions.
*/
BuildRunAction[] getBuildRunActions(int buildRunID);
/**
* Returns a list of test suite names.
*
* @return a list of test suite names.
*/
TestSuiteName[] getTestSuiteNames();
/**
* Returns a list of test case names.
*
* @param testSuiteNameID test suite name ID
* @return a list of test case names.
*/
TestCaseName[] getTestCaseNames(int testSuiteNameID);
/**
* Returns hourly build statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @return hourly build statistics.
*/
BuildStatistics[] getHourlyStatistics(int activeBuildID, Calendar fromDate, Calendar toDate);
/**
* Returns daily build statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @return daily build statistics.
*/
BuildStatistics[] getDailyStatistics(int activeBuildID, Calendar fromDate, Calendar toDate);
/**
* Returns monthly build statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @return monthly build statistics.
*/
BuildStatistics[] getMonthlyStatistics(int activeBuildID, Calendar fromDate, Calendar toDate);
/**
* Returns yearly build statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @return yearly build statistics.
*/
BuildStatistics[] getYearlyStatistics(int activeBuildID, Calendar fromDate, Calendar toDate);
/**
* Return hourly build distribution.
*
* @param activeBuildID
*
* @return hourly build distribution.
*/
BuildDistribution[] getHourlyBuildDistributions(int activeBuildID);
/**
* Return weekday build distribution.
*
* @param activeBuildID
*
* @return weekday build distribution.
*/
BuildDistribution[] getWeekdayBuildDistributions(int activeBuildID);
/**
* Returns hourly test statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @param testToolCode test tool code.
*
* @return hourly test statistics.
*/
TestStatistics[] getHourlyTestStatistics(int activeBuildID, final Calendar fromDate, final Calendar
toDate, byte testToolCode);
/**
* Returns daily test statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @param testToolCode test tool code.
*
* @return daily test statistics.
*/
TestStatistics[] getDailyTestStatistics(int activeBuildID, final Calendar fromDate, final Calendar
toDate, byte testToolCode);
/**
* Returns monthly test statistics.
*
* @param activeBuildID active build ID
* @param fromDate from date
* @param toDate to date
* @param testToolCode test tool code.
*
* @return monthly test statistics.
*/
TestStatistics[] getMonthlyTestStatistics(int activeBuildID, final Calendar fromDate, final Calendar
toDate, byte testToolCode);
/**
* Starts a build.
*
* @param activeBuildID ID of the build to start.
*/
void startBuild(int activeBuildID);
/**
* Starts the build.
*
* @param activeBuildID ID of the build to start.
* @param buildStartRequest an object containing a detailed build start request.
*/
void startBuild(int activeBuildID, BuildStartRequest buildStartRequest) throws IOException;BuildStartRequest has the following format:
Table 2.1.
| Field Name | Description |
| requestType | An integer request type. 0 means that this is a normal request. A normal requests starts build with the most recent change list number. 1 means that this is a build re-run. For build re-run buildRunID must be set. |
| cleanCheckout | A boolean clean checkout flag. If set to true, Parabuild will clean up a build workspace before starting the build. |
| pinResult | A boolean pin result flag. If set to true, build results will be pinned. |
| buildRunID | A build run ID to re-run. If this is not a re-rerun request, buildRunID must be set to -1. |
| changeListID | An integer change list number. The change list number can be used to start a manual build against a particular change list number. The change list number is supported for Perforce and Subversion. |
| userID | An integer ID of a user that starts the build. If not known, the user ID must be set to -1. |
| versionCounter | A string version counter. If not known, must be set to an empty string. |
| label | A string label that Parabuild has to apply to the version control system if build is successful. The label must be set to an empty string if no label should be applied. |
| note | A note that Parabuild has to add to the build. The note must be set to an empty string if no note should be added. |
| versionTemplate | A string version template Parabuild has to use to generate product version. The version template must be set to an empty string if no product version must be generated. |
| parameterList | A list of build start parameters. Please see the description BuildStartRequestParameter object for information. |
BuildStartRequestParameter has the following format:
/**
* Stops a build.
*
* @param activeBuildID ID of the build to stop.
*/
void stopBuild(int activeBuildID);
/**
* Resumes a previously stopped build.
*
* @param activeBuildID ID of the build to resume.
*/
void resumeBuild(int buildID);
/**
* Requests clean checkout. Parabuild will erase build's work space before running the next
build.
*
* @param activeBuildID ID of the build for that to perform a clean checkout.
*/
void requestCleanCheckout(int activeBuildID);
/**
* Returns a list of current build statuses.
*
* @return a list of current build statuses.
*/
BuildStatus[] getCurrentBuildStatuses();
/**
* Returns a current status for a build with the given ID.
*
* @param activeBuildID build ID
* @return a current status for a build with the given ID or null if there is no such build.
*/
public BuildStatus getCurrentBuildStatus(final int activeBuildID);
/**
* Returns a current status for a build with the given name.
*
* @param buildName case-sensitive build
* @return a current status for a build with the given name or null if there is no such build
*/
public BuildStatus getCurrentBuildStatus(final String buildName);
/** * Returns a list of current statuses for builds whose names match the give regex. * * @param regularExpression regular expression to match build names * @return a list of current statuses for builds whose names match the give regex */ BuildStatus[] findCurrentBuildStatuses(final String regularExpression);
/**
* Updates or creates version control settings.
*
* @param versionControlSettings version control settings to update or create.
*/
public void updateVersionControlSettings(final VersionControlSetting[] versionControlSettings)
/**
* Updates or creates build sequence.
*
* @param buildSequences build sequence to update or create.
*/
public void updateBuildSequences(final BuildSequence[] buildSequences)