The Bamboo REST APIs are for developers who want to integrate their application with Bamboo and for administrators who want to script interactions with the Bamboo server.
Bamboo's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML.
Because the REST API is based on open standards, you can use any web development language to access the API.
A common use case would be a build service, which provides information about build results.
Bamboo's REST APIs provide the following capabilities:
If you would like to know more about REST in general, start with the RESTwiki's guide to REST In Plain English.
Then jump right in and try our REST resources:
Below are some links to in-depth information on development of REST APIs and plugins:
In order to be minimise network traffic from the client perspective, our API uses a technique called expansion.
You can use the 'expand' query parameter to specify a comma-separated list of entities that you want expanded, identifying each entity by a given identifier. For example, the value "changes,stages.stage.results.result" requests the expansion of entities for which the expand identifier is "change" and "stages".
To discover the identifiers for each entity, look at the 'expand' attribute in the parent entity. In the XML example below, the page entity declares changes, metadata, artifacts, comments, labels, jiraIssues and stages as being expandable.
Note: The 'expand' attribute should not be confused with the 'expand' query parameter which specifies which entities you want expanded.
You can use the dot notation to specify expansion of entities within another entity. For example "children.children" would expand the children and the children's children (because its expand identifier is children) and the child entities within the plugin.
If not otherwise indicated, all methods return both XML and JSON. Below are examples of the XML and JSON representations.
<result id="2818060" expand="changes,testResults, metadata, logEntries,artifacts,comments, labels,jiraIssues" number="11"> lifeCycleState="Finished" state="Successful" key="PROJECTKEY-PLANKEY-JOB1-11"
<link rel="self" href="http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-JOB1-11"/>
<parent rel="parent" href="http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-11"/>
<planName>My plan</planName>
<projectName>My project</projectName>
<stage>Default Stage</stage>
</result>
{id:"2818060",
expand:"changes,testResults, metadata, logEntries,artifacts,comments, labels,jiraIssues",
number:"11"
lifeCycleState:"Finished"
state:"Successful"
key:"PROJECT_KEY-PLANKEY-JOB1-11"
link:[{href:"http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-JOB1-11",rel:"self"}],
parent:[{href:"http://localhost:8085/bamboo/rest/api/latest/result/PROJECTKEY-PLANKEY-11",rel:"parent"}],
planName:"My plan",
projectName:"My project",
stage:"Default Stage}}This document the current REST API provided by Bamboo.
A starts-with search of users based on their username, full-name and if allowed email address.
| parameter | value | description |
|---|---|---|
|
searchTerm |
Mandatory. The term to search for in users. |
|
|
includeAvatars |
if true will include avatar urls in the response. If gravatar is not enabled, no urls will be returned |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchResults start-index="0" max-result="1" size="1">
<searchResults id="jsmith" type="user">
<searchEntity xsi:type="userSearchResult" id="jsmith" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<username>jsmith</username>
<fullName>John Smith</fullName>
<displayableEmail>jsmith@example.com</displayableEmail>
<avatarUrl>https://secure.gravatar.com/avatar/asdfasdfasdfasdf.jpg?d=mm&s=16&r=g</avatarUrl>
</searchEntity>
</searchResults>
</searchResults>
Search results for users matching the provided search term
Source: schema1.xsd
<xs:complexType name="searchResultsList">
<xs:sequence>
<xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="start-index" type="xs:int" use="required"/>
<xs:attribute name="max-result" type="xs:int" use="required"/>
<xs:attribute name="size" type="xs:int" use="required"/>
</xs:complexType>A starts-with search of authors based on their authorname,
| parameter | value | description |
|---|---|---|
|
searchTerm |
Mandatory. The term to search for in authors. |
|
|
unlinkedOnly |
if true will only include authors which are not currently linked to a user. |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchResults start-index="0" max-result="1" size="1">
<searchResults id="jsmith" type="author">
<searchEntity xsi:type="authorSearchResult" id="jsmith" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<authorName>jsmith</authorName>
</searchEntity>
</searchResults>
</searchResults>
Search results for authors matching the provided search term
Source: schema1.xsd
<xs:complexType name="searchResultsList">
<xs:sequence>
<xs:element name="searchResults" type="searchResult" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="start-index" type="xs:int" use="required"/>
<xs:attribute name="max-result" type="xs:int" use="required"/>
<xs:attribute name="size" type="xs:int" use="required"/>
</xs:complexType>Performs a "starts with" search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans
| parameter | value | description |
|---|---|---|
|
searchTerm |
to search for. Optional |
available response representations:
Performs a "starts with" search against full plan branch name and full plan branch key. Branches are restricted to "masterPlanKey" plan.
| parameter | value | description |
|---|---|---|
|
masterPlanKey |
||
|
includeMasterBranch |
||
|
releasedInDeployment |
||
|
searchTerm |
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
Return all Package Definitions, including jobs.
available response representations:
| parameter | value | description |
|---|---|---|
|
projectId |
Performs a starts with search against full plan name and full plan key. Use "type" argument to filter by plan type by default will return TopLevelPlans
| parameter | value | description |
|---|---|---|
|
searchTerm |
to search for. Optional |
available response representations:
REST resource for starting/stopping/querying indexing.
Kicks off a reindex. Requires system admin permissions to perform this reindex.
| parameter | value | description |
|---|---|---|
|
indexer |
available response representations:
Returns status of the current indexing operation
Returns status of the current indexing operation. reindexInProgress - reindex is currently performed in background reindexPending - reindex is required (i.e. it failed before or some upgrade task asked for it)
available response representations:
Returns status of the current indexing operation
| parameter | value | description |
|---|---|---|
|
deploymentProjectId |
||
|
key |
| parameter | value | description |
|---|---|---|
|
key |
Method used to list all projects defined in Bamboo. Permissions for projects are checked based on Plan permissions (no project level permissions in Bamboo) Projects without any plan visible for user are not listed Should be invoked as /rest/api/latest/project <p/> Possible expand parameters projects - list of projects projects.project - list of projects with project details projects.project.plans - list of project details and plans for project projects.project.plans.plan - list of project details and plans for project with plan details
available response representations:
| parameter | value | description |
|---|---|---|
|
projectKey |
Method used to retrieve information for project specified as project key Should be invoked as /rest/api/latest/project/PROJECTKEY <p/> Possible expand parameters plans - list of plans for project plans.plan - list of plans with plan details (only plans visible - READ permission for user) plans.plan.actions - list of plans with plan details and actions available for user for plan
available response representations:
Provide build results information. Available for anonymous and authenticated users, however proper permissions are enforced
Provide list of latest build results for top level plans visible for users.
| parameter | value | description |
|---|---|---|
|
expand |
expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix. |
|
|
favourite |
filters build results list to show only results for favourite plans. Works only for authenticated user |
|
|
label |
filter by comma separated list of labels |
|
|
issueKey |
filter by comma separated list of Jira issue key related to result |
|
|
includeAllStates |
return all build results including Unknown states |
|
|
continuable |
filter only results that may be continued (stopped on Manual Stage) |
|
|
buildstate |
filter results by state, valid values are Unknown, Successful, Failed |
|
|
start-index |
start index for results list (zero based) |
|
|
max-results |
maximum size for returned list |
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<results start-index="0" max-result="2" size="0">
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>ANOTHER_PLAN_NAME</planName>
<projectName>ANOTHER_PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.129+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.129+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.129+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.129+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
</results>
</results>
Latest build results for all plans
Source: schema1.xsd
<xs:complexType name="restResults">
<xs:sequence>
<xs:element name="results" type="restResultList" minOccurs="0"/>
<xs:element ref="link" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
buildNumber |
buildNumber (numeric value or 'latest') |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified also as "latest" for latest result.
| parameter | value | description |
|---|---|---|
|
expand |
expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results |
|
|
favourite |
filters build results list to show only results for favourite plans. Works only for authenticated user |
|
|
start-index |
start index for results list (zero based) |
|
|
max-results |
maximum size for returned list |
available response representations:
Returned when specified project or plan does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
<changes expand="changes" start-index="0" max-result="2" size="0">
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
</changes>
<metadata start-index="0" max-result="1" size="0">
<item key="ManualBuildTriggerReason.userName" value="admin"/>
</metadata>
</result>
Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.
Source: schema1.xsd
<xs:complexType name="resultDetails">
<xs:complexContent>
<xs:extension base="result">
<xs:sequence>
<xs:element name="changes" type="restChangeList" minOccurs="0"/>
<xs:element name="testResults" type="restTestResults" minOccurs="0"/>
<xs:element name="metadata" type="restBuildMetadataList" minOccurs="0"/>
<xs:element ref="progress" minOccurs="0"/>
<xs:element name="queue" type="restBuildQueueStatus" minOccurs="0"/>
<xs:element name="logEntries" type="restBuildLogEntryList" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>Returned when user has no permission to view specified plan
| parameter | value | description |
|---|---|---|
|
projectKey |
project key to filter plan result list |
Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user.
| parameter | value | description |
|---|---|---|
|
expand |
expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix. |
|
|
favourite |
filters build results list to show only results for favourite plans. Works only for authenticated user |
|
|
label |
filter by comma separated list of labels |
|
|
issueKey |
filter by comma separated list of Jira issue key related to result |
|
|
includeAllStates |
return all build results including Unknown states |
|
|
continuable |
filter only results that may be continued (stopped on Manual Stage) |
|
|
buildstate |
filter results by state, valid values are Unknown, Successful, Failed |
|
|
start-index |
start index for results list (zero based) |
|
|
max-results |
maximum size for returned list |
available response representations:
Returned when specified project does not exists or user does not have permission to see plans for specified project
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<results start-index="0" max-result="1" size="0">
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.129+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.129+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.129+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.129+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
</results>
</results>
Latest build results for plans for specified project
Source: schema1.xsd
<xs:complexType name="restResults">
<xs:sequence>
<xs:element name="results" type="restResultList" minOccurs="0"/>
<xs:element ref="link" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
csid |
changeset id related to build result |
Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans related to this changeset.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<results start-index="0" max-result="2" size="0">
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.129+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.129+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.129+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.129+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
</results>
</results>
Build results for specified changeset.
Source: schema1.xsd
<xs:complexType name="restResults">
<xs:sequence>
<xs:element name="results" type="restResultList" minOccurs="0"/>
<xs:element ref="link" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).
| parameter | value | description |
|---|---|---|
|
expand |
expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix. |
|
|
favourite |
filters build results list to show only results for favourite plans. Works only for authenticated user |
|
|
label |
filter by comma separated list of labels |
|
|
issueKey |
filter by comma separated list of Jira issue key related to result |
|
|
includeAllStates |
return all build results including Unknown states |
|
|
continuable |
filter only results that may be continued (stopped on Manual Stage) |
|
|
buildstate |
filter results by state, valid values are Unknown, Successful, Failed |
|
|
start-index |
start index for results list (zero based) |
|
|
max-results |
maximum size for returned list |
available response representations:
Returned when specified project or plan does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<results start-index="0" max-result="2" size="0">
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.129+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.129+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.129+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.129+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
</results>
</results>
Latest build results for specified plan. Results are ordered from latest or oldest.
Source: schema1.xsd
<xs:complexType name="restResults">
<xs:sequence>
<xs:element name="results" type="restResultList" minOccurs="0"/>
<xs:element ref="link" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>Returned when user has no permission to view specified plan
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
branchName |
||
|
projectKey |
Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).
| parameter | value | description |
|---|---|---|
|
expand |
||
|
favourite |
||
|
label |
||
|
issueKey |
||
|
includeAllStates |
||
|
continuable |
||
|
buildstate |
||
|
start-index |
||
|
max-results |
available response representations:
Returned when specified project or plan does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<results start-index="0" max-result="2" size="0">
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="ANOTHERPPROJECTKEY-ANOTHERPLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="1" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.129+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.129+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.129+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.129+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
</result>
</results>
</results>
Latest build results for specified plan. Results are ordered from latest or oldest.
Source: schema1.xsd
<xs:complexType name="restResults">
<xs:sequence>
<xs:element name="results" type="restResultList" minOccurs="0"/>
<xs:element ref="link" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>Returned when user has no permission to view specified plan
| parameter | value | description |
|---|---|---|
|
buildNumber |
buildNumber (numeric value or 'latest') |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide build result specified by projectKey-buildKey-buildNumber. Build number may be specified also as "latest" for latest result.
| parameter | value | description |
|---|---|---|
|
expand |
expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results |
|
|
favourite |
filters build results list to show only results for favourite plans. Works only for authenticated user |
|
|
start-index |
start index for results list (zero based) |
|
|
max-results |
maximum size for returned list |
available response representations:
Returned when specified project or plan does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<result expand="changes,metadata,artifacts,comments,labels,jiraIssues,stages" key="PPROJECTKEY-PLANKEY-2" state="SUCCESS" lifeCycleState="Finished" number="2" id="10000" continuable="false" onceOff="false" restartable="false">
<planName>PLAN_NAME</planName>
<projectName>PROJECT_NAME</projectName>
<buildStartedTime>2014-07-30T00:07:30.045+10:00</buildStartedTime>
<prettyBuildStartedTime>2014-07-30T00:07:30</prettyBuildStartedTime>
<buildCompletedTime>2014-07-30T00:07:30.118+10:00</buildCompletedTime>
<buildCompletedDate>2014-07-30T00:07:30.118+10:00</buildCompletedDate>
<prettyBuildCompletedTime>2014-07-30T00:07:30</prettyBuildCompletedTime>
<buildDurationInSeconds>1</buildDurationInSeconds>
<buildDuration>1000</buildDuration>
<buildDurationDescription>1 second</buildDurationDescription>
<buildRelativeTime>1 hour ago</buildRelativeTime>
<queueStartedTime>2014-07-30T00:07:30.118+10:00</queueStartedTime>
<prettyQueueStartedTime>2014-07-30T00:07:30</prettyQueueStartedTime>
<restartCount>0</restartCount>
<artifacts start-index="0" max-result="1" size="0">
<artifact>
<name>cargo log</name>
<link href="http://localhost:8085/bamboo/browse/PROJECTKEY-PLANKEY-2/artifact/shared/cargo-log.log" rel="self"/>
<producerJobKey>PROJECTKEY-PLANKEY-2</producerJobKey>
<shared>true</shared>
<size>1024</size>
<prettySizeDescription>1 kilobyte</prettySizeDescription>
</artifact>
</artifacts>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
<jiraIssues start-index="0" max-result="2" size="0">
<issue key="BAM-9040" summary="Break out the Run options from the current menu" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9040" rel="self"/>
</issue>
<issue key="BAM-9137" summary="Task to allow users to tag and branch in SVN" iconUrl="https://jira.atlassian.com/images/icons/sales.gif" issueType="Story" status="Resolved" statusIconUrl="https://jira.atlassian.com/images/icons/status_resolved.gif">
<url href="https://jira.atlassian.com/browse/BAM-9137" rel="self"/>
</issue>
</jiraIssues>
<changes expand="changes" start-index="0" max-result="2" size="0">
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
</changes>
<metadata start-index="0" max-result="1" size="0">
<item key="ManualBuildTriggerReason.userName" value="admin"/>
</metadata>
</result>
Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag.
Source: schema1.xsd
<xs:complexType name="resultDetails">
<xs:complexContent>
<xs:extension base="result">
<xs:sequence>
<xs:element name="changes" type="restChangeList" minOccurs="0"/>
<xs:element name="testResults" type="restTestResults" minOccurs="0"/>
<xs:element name="metadata" type="restBuildMetadataList" minOccurs="0"/>
<xs:element ref="progress" minOccurs="0"/>
<xs:element name="queue" type="restBuildQueueStatus" minOccurs="0"/>
<xs:element name="logEntries" type="restBuildLogEntryList" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>Returned when user has no permission to view specified plan
| parameter | value | description |
|---|---|---|
|
buildNumber |
build number |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide list of comments for build result specified by projectKey-buildKey-buildNumber. Build number may be specified also as "latest" for latest result.
available response representations:
Returned when specified project, plan or build result does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comments>
<comments start-index="0" max-result="2" size="0">
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
<comment author="bambooUser">
<content>Sample comment for build</content>
<creationDate>2014-07-30T00:07:30.119+10:00</creationDate>
<modificationDate>2014-07-30T00:07:30.119+10:00</modificationDate>
</comment>
</comments>
</comments>
List of comments for build result
Returned when user has no permission to view specified plan
Adds new comment to build result specified by projectKey-buildKey-buildNumber.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comment>
<content>new comment content</content>
</comment>
Source: schema1.xsd
<xs:complexType name="restComment">
<xs:sequence>
<xs:element name="modificationDate" type="xs:string" minOccurs="0"/>
<xs:element name="creationDate" type="xs:string" minOccurs="0"/>
<xs:element name="content" type="xs:string" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="author" type="xs:string"/>
</xs:complexType>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<comment>
<content>new comment content</content>
</comment>
Source: schema1.xsd
<xs:complexType name="restComment">
<xs:sequence>
<xs:element name="modificationDate" type="xs:string" minOccurs="0"/>
<xs:element name="creationDate" type="xs:string" minOccurs="0"/>
<xs:element name="content" type="xs:string" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="author" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
buildNumber |
buildNumber (numeric value or 'latest') |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide list of labels for build result specified by projectKey-buildKey-buildNumber. Build number may be specified also as "latest" for latest result.
available response representations:
Returned when specified project, plan or build result does not exists
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<labels>
<labels start-index="0" max-result="2" size="0">
<label name="someLabel"/>
<label name="someLabel"/>
</labels>
</labels>
List of comments for build result
Returned when user has no permission to view specified plan
Adds new label to build result specified by projectKey-buildKey-buildNumber.
acceptable request representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>
Source: schema1.xsd
<xs:complexType name="restBuildLabel">
<xs:sequence/>
<xs:attribute name="name" type="xs:string"/>
</xs:complexType>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<label name="someLabel"/>
Source: schema1.xsd
<xs:complexType name="restBuildLabel">
<xs:sequence/>
<xs:attribute name="name" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
buildNumber |
buildNumber (numeric value or 'latest') |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
labelName |
label name to remove from build result |
|
|
projectKey |
project key |
Removes label from build result specified by projectKey-buildKey-buildNumber.
| parameter | value | description |
|---|---|---|
|
buildNumber |
buildNumber (numeric value only, 'latest' keyword is not supported for this method) |
|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide runtime information for currently executing build result. The key difference to other methods is that method is optimized to provide information available in memory only, so no database calls are made. The information provided is not as wide as for finished results, but the call is optimized for speed.
available response representations:
Returned when specified project, plan or build result does not exists. Also when build result is not currently executed ie. build has been completed already
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<status expand="stages" key="PROJECTKEY-PLANKEY-100">
<finished>false</finished>
<prettyQueuedTime>2014-07-30T00:07:31</prettyQueuedTime>
<progress>
<isValid>true</isValid>
<isUnderAverageTime>true</isUnderAverageTime>
<percentageCompleted>0.4669655761516365</percentageCompleted>
<percentageCompletedPretty>46%</percentageCompletedPretty>
<prettyTimeRemaining>Approximately 2 minutes remaining</prettyTimeRemaining>
<prettyTimeRemainingLong>Approximately 2 minutes remaining</prettyTimeRemainingLong>
<averageBuildDuration>120000</averageBuildDuration>
<prettyAverageBuildDuration>2 mins</prettyAverageBuildDuration>
<buildTime>60000</buildTime>
<prettyBuildTime>1 min</prettyBuildTime>
</progress>
<currentStage>first stage</currentStage>
<stages expand="stage" start-index="0" max-result="1" size="0">
<stage>
<results expand="results" start-index="0" max-result="1" size="0">
<result expand="result" state="Unknown">
<progress>
<isValid>true</isValid>
<isUnderAverageTime>true</isUnderAverageTime>
<percentageCompleted>0.4669655761516365</percentageCompleted>
<percentageCompletedPretty>46%</percentageCompletedPretty>
<prettyTimeRemaining>Approximately 2 minutes remaining</prettyTimeRemaining>
<prettyTimeRemainingLong>Approximately 2 minutes remaining</prettyTimeRemainingLong>
<averageBuildDuration>120000</averageBuildDuration>
<prettyAverageBuildDuration>2 mins</prettyAverageBuildDuration>
<buildTime>60000</buildTime>
<prettyBuildTime>1 min</prettyBuildTime>
</progress>
<waiting>false</waiting>
<queued>false</queued>
<updatingSource>false</updatingSource>
<prettyVcsUpdateDuration>10 seconds</prettyVcsUpdateDuration>
</result>
</results>
<name>stageName</name>
<description>stage description</description>
<isBuilding>true</isBuilding>
<isCompleted>false</isCompleted>
<isSuccessful>false</isSuccessful>
<index>0</index>
</stage>
</stages>
</status>
Currently executing build status
Returned when user has no permission to view specified plan
Directory resource for Bamboo REST resources
Provides list of available REST resources in Bamboo
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resources>
<resources start-index="0" max-result="0" size="0">
<resource name="info">
<link href="http://localhost:8085/bamboo/rest/api/latest/info" rel="self"/>
</resource>
<resource name="project">
<link href="http://localhost:8085/bamboo/rest/api/latest/project" rel="self"/>
</resource>
<resource name="plan">
<link href="http://localhost:8085/bamboo/rest/api/latest/plan" rel="self"/>
</resource>
<resource name="result">
<link href="http://localhost:8085/bamboo/rest/api/latest/result" rel="self"/>
</resource>
<resource name="chart">
<link href="http://localhost:8085/bamboo/rest/api/latest/chart" rel="self"/>
</resource>
<resource name="queue">
<link href="http://localhost:8085/bamboo/rest/api/latest/queue" rel="self"/>
</resource>
<resource name="export">
<link href="http://localhost:8085/bamboo/rest/api/latest/export" rel="self"/>
</resource>
<resource name="clone">
<link href="http://localhost:8085/bamboo/rest/api/latest/clone" rel="self"/>
</resource>
<resource name="currentUser">
<link href="http://localhost:8085/bamboo/rest/api/latest/currentUser" rel="self"/>
</resource>
</resources>
</resources>
List of available REST resources
Source: schema1.xsd
<xs:complexType name="restResources">
<xs:sequence>
<xs:element ref="link" minOccurs="0"/>
<xs:element name="resources" type="restResourceList" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
executorType |
||
|
executorId |
available response representations:
| parameter | value | description |
|---|---|---|
|
executorType |
||
|
executorId |
||
|
assignmentType |
||
|
entityId |
available response representations:
| parameter | value | description |
|---|---|---|
|
configurationId |
| parameter | value | description |
|---|---|---|
|
configurationName |
| parameter | value | description |
|---|---|---|
|
imageId |
| parameter | value | description |
|---|---|---|
|
id |
| parameter | value | description |
|---|---|---|
|
id |
| parameter | value | description |
|---|---|---|
|
id |
| parameter | value | description |
|---|---|---|
|
id |
| parameter | value | description |
|---|---|---|
|
toBuildKey |
||
|
buildKey |
||
|
toProjectKey |
||
|
projectKey |
Lists all the builds waiting in the build queue, adds or removes a build from the build queue. May be used also to resume build on manual stage or rerun failed jobs.
Provide list of build scheduled for execution and waiting in build queue.
available response representations:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<queue expand="queuedBuilds">
<queuedBuilds start-index="0" max-result="1" size="0">
<queuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
<triggerReason>Manual build</triggerReason>
<changes expand="changes" start-index="0" max-result="2" size="0">
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
</changes>
</queuedBuild>
</queuedBuilds>
</queue>
List of queued builds waiting in the build queue
Source: schema1.xsd
<xs:complexType name="restQueuedBuilds">
<xs:sequence>
<xs:element ref="link" minOccurs="0"/>
<xs:element name="queuedBuilds" type="restQueuedBuildList" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="expand" type="xs:string"/>
</xs:complexType>| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
Fire build execution for specified plan. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method either as form encoded POST payload or query parameters. PLEASE note: Query parameters are more important - override those stored in form payload. Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override default values for variables.
| parameter | value | description |
|---|---|---|
|
stage |
||
|
executeAllStages |
||
|
customRevision |
acceptable request representations:
available response representations:
Returned when POST method payload is not form encoded
Returned when specified plan does not exist or plan is not a top level plan
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restQueuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
<triggerReason>Manual build</triggerReason>
<changes expand="changes" start-index="0" max-result="2" size="0">
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
</changes>
</restQueuedBuild>
Information for queued build, including build number, changes and reason of build
Returned when user does not have sufficient rights to view or execute build for specified plan
Returned when build was not added to the queue because of Bamboo limitation - for example too many concurrent builds running for requested plan already
| parameter | value | description |
|---|---|---|
|
buildNumber |
build number to resume/rerun |
|
|
buildKey |
plan key (only top level plan key, can not be job key) |
|
|
projectKey |
project key |
Continue partially done build. Effectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately. Depending on currently executed builds and length of build queue, build may be executed when queue would be drained. Additional variables could be passed to this method only query parameters (variableName=variableValue). Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable. When global or plan variables would be passed to this method, will override values valid for previous build execution (override).
| parameter | value | description |
|---|---|---|
|
stage |
name of the stage that should be executed even if manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage |
|
|
executeAllStages |
enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail. |
available response representations:
Returned when specified plan does not exist, result for provided build number does not exist or is not top level plan result
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restQueuedBuild expand="queuedBuild" planKey="PROJECTKEY-PLANKEY" buildNumber="10" buildResultKey="PROJECTKEY-PLANKEY-10">
<triggerReason>Manual build</triggerReason>
<changes expand="changes" start-index="0" max-result="2" size="0">
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
<change expand="change" author="Author" changesetId="10">
<comment>Sample comment</comment>
<date>2014-07-30T00:07:30.123+10:00</date>
<files start-index="0" max-result="3" size="0">
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
<file>
<name>some/example/path/to/File.java</name>
<revision>10</revision>
</file>
</files>
</change>
</changes>
</restQueuedBuild>
Information for queued build, including build number, changes and reason of build
Returned when user does not have sufficient rights to view or execute build for specified plan
Returned when build is currently executing or is in state not allowing execution
| parameter | value | description |
|---|---|---|
|
buildNumber |
build number |
|
|
buildKey |
plan key - IMPORTANT: as build queue contains only jobs not top level plans, plan key here MUST be a job key as opposite to other methods in this resource. |
|
|
projectKey |
project key |
Stop build execution, however only if build has not been started yet - so if is waiting in the build queue. If build does not exist in the queue anymore, method has no effect.
available response representations:
| parameter | value | description |
|---|---|---|
|
id |
| parameter | value | description |
|---|---|---|
|
id |
||
|
state |
| parameter | value | description |
|---|---|---|
|
planKey |
| parameter | value | description |
|---|---|---|
|
environmentId |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
projectId |
Plan service is supposed to be used to retrieve full list of plans and plan details
Method used to list all plans on Bamboo service that user is allowed to see (READ permission). Should be invoked as /rest/api/latest/plan <p/> Possible expand parameters plans - list of plans plans.plan - list of plans with plan details plans.plan.actions <p/>
available response representations:
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide list of branches for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey). You can use "enabledOnly" param to filter out disabled branches.
available response representations:
| parameter | value | description |
|---|---|---|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
branchName |
branch display name |
|
|
projectKey |
project key |
Method for creating branch for a specified plan. You can use vcsBranch query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the main plan. Example usage: curl -X PUT --user admin:admin http://localhost:8085/rest/api/latest/plan/PROJ-PLAN/branch/BranchName?vcsBranch="/refs/heads/myBranch"
available response representations:
Provide details for specified Branch of a specified Plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).
available response representations:
| parameter | value | description |
|---|---|---|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
projectKey |
project key |
Provide list of labels for plan specified by projectKey-buildKey.
available response representations:
Adds new label to plan specified by projectKey-buildKey.
acceptable request representations:
| parameter | value | description |
|---|---|---|
|
buildKey |
plan key (might be simply planKey or composite planKey-jobKey) |
|
|
labelName |
label name to remove from plan |
|
|
projectKey |
project key |
Removes label from plan specified by projectKey-buildKey-buildNumber.
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
Provide list of vcs branch names for branches that exist on the default repository of this plan
available response representations:
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
issueKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |
| parameter | value | description |
|---|---|---|
|
buildKey |
||
|
projectKey |