Rate this page:
Available: | Bamboo 2.3 introduced the REST APIs. |
Changed: | In Bamboo 3.0 the |
The Bamboo REST APIs allow you to address the Bamboo data entities as 'resources'. This means that they are identified by URIs and operated on by HTTP requests, such as GET. Whenever you GET one of these resources, you receive a representation encoded using XML or JSON.
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
The REST API usage guide describes common factors in the APIs, including the full structure of the URIs, API versions, etc. Below are details of the resources made available by the APIs.
You can always view the root level resources for a particular version of a Bamboo REST API by navigating to the root URI. e.g.
1 2http://myhost.com:8085/rest/api/latest/
The response of a REST call will always contains information about size of whole collection (size
attribute) as well as the start-index
and max-result
.
The number of resources in returned lists is limited to 25, unless you specify max-result
.
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Lists all the projects set up on the Bamboo server. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <projects expand="projects"> <link rel="self" href="http://myhost:8085/rest/api/latest/project" /> - <projects expand="project" size="2" max-result="2" start-index="0"> - <project name="MyProject1" key="MYPROJ1"> <link rel="self" href="http://myhost:8085/rest/api/latest/project/MYPROJ1" /> </project> - <project name="MyProject2" key="MYPROJ2"> <link rel="self" href="http://myhost:8085/rest/api/latest/project/MYPROJ2" /> </project> </projects> </projects>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
Example of response JSON:
1 2{"expand":"projects","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/project"}, "projects":{"expand":"project","size":2,"max-result":2,"start-index":0,"project":[ {"name":"MyProject1","key":"MYPROJ1","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/project/MYPROJ1"}}, {"name":"MyProject2","key":"MYPROJ2","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/project/MYPROJ2"}} ]}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Lists all the plans set up on the Bamboo server. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <plans expand="plans"> <link rel="self" href="http://myhost:8085/rest/api/latest/plan"/> - <plans expand="plan" size="3" max-result="3" start-index="0"> - <plan enabled="true" plan name="My Plan 1" key="MYPLAN1"> <link rel="self" href="http://myhost:8085/rest/api/latest/plan/MYPLAN1"/> </plan> - <plan enabled="true" name="My Plan 2" key="MYPLAN2"> <link rel="self" href="http://myhost:8085/rest/api/latest/plan/MYPLAN2"/> </plan> - <plan enabled="true" name="My Plan 3" key="MYPLAN3"> <link rel="self" href="http://myhost:8085/rest/api/latest/plan/MYPLAN3"/> </plan> </plans> </plans>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
Example of response JSON:
1 2{"expand":"plans","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/plan"}, "plans":{"expand":"plan","size":2,"max-result":2,"start-index":0,"plan":[ {"name":"My Plan 1","key":"MYPLAN1","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/plan/MYPLAN1"}}, {"name":"My Plan 2","key":"MYPLAN2","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/plan/MYPLAN2"}} {"name":"My Plan 3","key":"MYPLAN3","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/plan/MYPLAN3"}} ]}}
Changed: | In Bamboo 3.0 the |
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Lists the latest builds for all plans on the Bamboo server. |
URI Parameters |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <results expand="results"> <link rel="self" href="http://myhost:8085/rest/api/latest/result"/> - <results expand="result" size="5" max-result="5" start-index="0"> - <result number="2" state="Successful" key="MYPLAN1-2"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN1-2"/> </result> <result number="5" state="Successful" key="MYPLAN2-5"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN2-5"/> </result> <result number="4" state="Successful" key="MYPLAN3-4"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN3-4"/> </result> <result number="5" state="Successful" key="MYPLAN4-5"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ2-MYPLAN4-5"/> </result> <result number="5" state="Successful" key="MYPLAN5-5"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ3-MYPLAN5-5"/> </result> </results> </results>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
| Description: Start time of build |
| Description: Finish time of build |
| Description: Build duration in seconds |
| Description: Description of build duration (conversion of seconds to more usable units of time) |
| Description: Time when build was run (relative to current time) |
| Description: Time when build was queued |
| Description: How long build was queued |
| Description: Time when VCS update occurred |
| Description: How long VCS took to complete |
| Description: Summary of test results |
| Description: Number of successful tests in build |
| Description: Number of failed tests in build |
| Description: Reason for build |
| Description: Name of the build artifact |
|
|
| Description: Name of the label |
|
|
|
|
| Description: Date that comment was created |
| Description: Date that comment was last updated |
|
|
|
|
Example of response JSON:
1 2{"expand":"results","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/result"}, "builds":{"expand":"result","size":5,"max-result":5,"start-index":0,"result":[ {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN1","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN1-2"}}, {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN2","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN2-5"}}, {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN3","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN3-4"}}, {"number":,"state":"Successful","key":"MYPROJ2-MYPLAN4","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ2-MYPLAN4-5"}}, {"number":,"state":"Successful","key":"MYPROJ3-MYPLAN5","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ3-MYPLAN5-5"}}, ]}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Lists the latest builds for all plans for a specific project on the Bamboo server. |
URI Parameters |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <results expand="results"> <link rel="self" href="http://myhost:8085/rest/api/latest/result"/> - <results expand="result" size="3" max-result="3" start-index="0"> - <result number="2" state="Successful" key="MYPROJ1-MYPLAN1-2"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN1-2"/> </result> <result number="5" state="Successful" key="MYPROJ1-MYPLAN2-5"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN2-5"/> </result> <result number="4" state="Successful" key="MYPROJ1-MYPLAN3-4"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN3-4"/> </result> </results> </results>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
| Description: Start time of build |
| Description: Finish time of build |
| Description: Build duration in seconds |
| Description: Description of build duration (conversion of seconds to more usable units of time) |
| Description: Time when build was run (relative to current time) |
| Description: Time when build was queued |
| Description: How long build was queued |
| Description: Time when VCS update occurred |
| Description: How long VCS took to complete |
| Description: Summary of test results |
| Description: Number of successful tests in build |
| Description: Number of failed tests in build |
| Description: Reason for build |
| Description: Name of the build artifact |
|
|
| Description: Name of the label |
|
|
|
|
| Description: Date that comment was created |
| Description: Date that comment was last updated |
|
|
|
|
Example of response JSON:
1 2{"expand":"results","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/result"}, "results":{"expand":"result","size":3,"max-result":3,"start-index":0,"result":[ {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN1","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN1-2"}}, {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN2","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN2-5"}}, {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN3","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN3-4"}}, ]}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Provides information about builds executed for a build plan from latest to the first build |
URI Parameters |
|
HTTP Methods |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <results expand="results"> <link rel="self" href="http://myhost:8085/rest/api/latest/result"/> - <results expand="result" size="2" max-result="2" start-index="0"> - <result number="1" state="Successful" key="MYPROJ1-MYPLAN6-1"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN6-1"/> </result> <result number="2" state="Successful" key="MYPROJ1-MYPLAN6-2"> <link rel="self" href="http://myhost:8085/rest/api/latest/result/MYPROJ1-MYPLAN6-2"/> </result> </results> </results>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
| Description: Start time of build |
| Description: Finish time of build |
| Description: Build duration in seconds |
| Description: Description of build duration (conversion of seconds to more usable units of time) |
| Description: Time when build was run (relative to current time) |
| Description: Time when build was queued |
| Description: How long build was queued |
| Description: Time when VCS update occurred |
| Description: How long VCS took to complete |
| Description: Summary of test results |
| Description: Number of successful tests in build |
| Description: Number of failed tests in build |
| Description: Reason for build |
| Description: Name of the build artifact |
|
|
| Description: Name of the label |
|
|
|
|
| Description: Date that comment was created |
| Description: Date that comment was last updated |
|
|
|
|
Example of response JSON:
1 2{"expand":"results","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/result"}, "results":{"expand":"result","size":2,"max-result":2,"start-index":0,"result":[ {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN6","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN6-1"}}, {"number":,"state":"Successful","key":"MYPROJ1-MYPLAN6","link":{"rel":"self","href":"http://panda:8085/rest/api/latest/result/MYPROJ1-MYPLAN6-1"}}, ]}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Provides information about a single build executed for a build plan (build result information only) |
URI Parameters |
|
HTTP Methods |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <result number="5157" state="Successful" key="MYPLAN1-5157" expand="artifacts"> <failedTestCount>0</failedTestCount> <successfulTestCount>1617</successfulTestCount> <buildStartedTime>2009-06-15T14:56:06.821+1000</buildStartedTime> <buildCompletedTime>2009-06-15T15:14:10.994+1000</buildCompletedTime> <buildDurationInSeconds>1084.0</buildDurationInSeconds> <buildDurationDescription>18 minutes</buildDurationDescription> <buildRelativeTime>1 hour ago</buildRelativeTime> <buildTestSummary>1617 passed</buildTestSummary> <buildReason><a href="http://myhost:8085/browse/MYPLAN1-5157/commit">Updated by Austin Powers</a></buildReason> <queueStartedTime>2009-06-15T14:53:54.499+1000</queueStartedTime> <queueTimeInSeconds>1.0</queueTimeInSeconds> <vcsUpdateStartedTime>2009-06-15T14:53:55.546+1000</vcsUpdateStartedTime> <vcsUpdateInSeconds>131.0</vcsUpdateInSeconds> <artifacts size="1" max-result="1" start-index="0" /> <link rel="self" href="http://myhost:8085/rest/api/latest/build/MYPLAN1-5157" /> </result>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
| Description: Start time of build |
| Description: Finish time of build |
| Description: Build duration in seconds |
| Description: Description of build duration (conversion of seconds to more usable units of time) |
| Description: Time when build was run (relative to current time) |
| Description: Time when build was queued |
| Description: How long build was queued |
| Description: Time when VCS update occurred |
| Description: How long VCS took to complete |
| Description: Summary of test results |
| Description: Number of successful tests in build |
| Description: Number of failed tests in build |
| Description: Reason for build |
| Description: Name of the build artifact |
|
|
| Description: Name of the label |
|
|
|
|
| Description: Date that comment was created |
| Description: Date that comment was last updated |
|
|
|
|
|
|
| Description: Comment associated with the changeset |
| Description: Date of the changeset |
| Description: Name of the file associated with the changeset |
| Description: Revision of the file associated with the changeset |
|
|
|
|
|
|
| Description: Duration of test |
| Description: Duration of test in seconds |
|
|
| Description: Error message for error in failed test. |
Example of response JSON:
1 2{"number":5157,"state":"Successful","key":"MYPLAN1-5157","expand":"artifacts", "failedTestCount":0, "successfulTestCount":1617, "buildStartedTime":"2009-06-15T14:56:06.821+1000", "buildCompletedTime":"2009-06-15T15:14:10.994+1000", "buildDurationInSeconds":1084.0, "buildDurationDescription":"18 minutes", "buildRelativeTime":"2 hours ago", "buildTestSummary":"1617 passed", "buildReason":"<a href=\"http://myhost:8085/browse/BAM-MAIN-5157/commit\">Updated by Austin Powers</a>", "queueStartedTime":"2009-06-15T14:53:54.499+1000", "queueTimeInSeconds":1.0, "vcsUpdateStartedTime":"2009-06-15T14:53:55.546+1000", "vcsUpdateInSeconds":131.0, "artifacts":{"size":1,"max-result":1,"start-index":0}, "link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/result/MYPLAN1-5157"}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Returns detailed information on a specific chart, or returns the list of reports set up on the Bamboo server. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML (list all available reports):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <chart> <location>jfreechart-onetime-3627918147160569458.png</location> <imageMapName>OZ6yx_map</imageMapName> <imageMap> <map id="OZ6yx_map" name="OZ6yx_map"> <area shape="poly" coords="373,45,379,45,379,51,373,51,373,45,373,45" title="INT-TST on average took 38 seconds for June 2009" alt="" nohref="nohref"/> <area shape="poly" coords="328,76,334,76,334,82,328,82,328,76,328,76" title="INT-TST on average took 36 seconds for May 2009" alt="" nohref="nohref"/> <area shape="poly" coords="284,121,290,121,290,127,284,127,284,121,284,121" title="INT-TST on average took 32 seconds for April 2009" alt="" nohref="nohref"/> <area shape="poly" coords="239,242,245,242,245,248,239,248,239,242,239,242" title="INT-TST on average took 23 seconds for March 2009" alt="" nohref="nohref"/> <area shape="poly" coords="199,190,205,190,205,196,199,196,199,190,199,190" title="INT-TST on average took 27 seconds for February 2009" alt="" nohref="nohref"/> <area shape="poly" coords="154,14,160,14,160,20,154,20,154,14,154,14" title="INT-TST on average took 40 seconds for January 2009" alt="" nohref="nohref"/> <area shape="poly" coords="109,204,115,204,115,210,109,210,109,204,109,204" title="INT-TST on average took 26 seconds for December 2008" alt="" nohref="nohref"/> <area shape="poly" coords="65,210,71,210,71,216,65,216,65,210,65,210" title="INT-TST on average took 26 seconds for November 2008" alt="" nohref="nohref"/> <area shape="poly" coords="379,58,378,60,376,61,374,60,373,58,374,56,376,55,378,56,379,58,379,58" title="ACC-TST on average took 37 seconds for June 2009" alt="" nohref="nohref"/> <area shape="poly" coords="334,107,333,109,331,110,329,109,328,107,329,105,331,104,333,105,334,107,334,107" title="ACC-TST on average took 33 seconds for May 2009" alt="" nohref="nohref"/> <area shape="poly" coords="290,138,290,140,287,141,285,140,284,138,285,136,287,135,290,136,290,138,290,138" title="ACC-TST on average took 31 seconds for April 2009" alt="" nohref="nohref"/> <area shape="poly" coords="245,155,245,157,242,158,240,157,239,155,240,153,242,152,245,153,245,155,245,155" title="ACC-TST on average took 30 seconds for March 2009" alt="" nohref="nohref"/> <area shape="poly" coords="205,182,204,184,202,185,200,184,199,182,200,180,202,179,204,180,205,182,205,182" title="ACC-TST on average took 28 seconds for February 2009" alt="" nohref="nohref"/> <area shape="poly" coords="160,186,159,188,157,189,154,188,154,186,154,184,157,183,159,184,160,186,160,186" title="ACC-TST on average took 28 seconds for January 2009" alt="" nohref="nohref"/> <area shape="poly" coords="115,212,114,214,112,215,109,214,109,212,109,210,112,209,114,210,115,212,115,212" title="ACC-TST on average took 26 seconds for December 2008" alt="" nohref="nohref"/> <area shape="poly" coords="71,195,70,197,68,198,66,197,65,195,66,193,68,192,70,193,71,195,71,195" title="ACC-TST on average took 27 seconds for November 2008" alt="" nohref="nohref"/> </map> </imageMap> <width>400</width> <height>320</height> </chart>
Elements in the response:
Element | Attributes |
---|---|
| Description: URL for the chart image |
| Description: Name of the imagemap |
|
|
| Description: width of the chart image in pixels |
| Description: height of the chart image in pixels |
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Returns the list of reports set up on the Bamboo server. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML (list all available reports):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <reports expand="reports"> <link rel="self" href="http://myhost:8085/rest/api/latest/chart/reports" /> - <reports size="7" max-result="7" start-index="0"> - <report> <key>com.atlassian.bamboo.plugin.system.reports:numberOfBuilds</key> <name>Build Activity</name> </report> - <report> <key>com.atlassian.bamboo.plugin.system.reports:averageDuration</key> <name>Build Duration</name> </report> - <report> <key>com.atlassian.bamboo.plugin.system.reports:averageQueuedDuration</key> <name>Build Queued Duration</name> </report> - <report> <key>com.atlassian.bamboo.plugin.myproject1:myproject1Coverage</key> <name>My Project 1 Code Coverage</name> </report> - <report> <key>com.atlassian.bamboo.plugin.myproject1:myproject1LinesOfCode</key> <name>My Project 1 Lines of Code</name> </report> - <report> <key>com.atlassian.bamboo.plugin.system.reports:numberOfFailures</key> <name>Number of Build Failures</name> </report> - <report> <key>com.atlassian.bamboo.plugin.system.reports:numberOfTests</key> <name>Number of Tests</name> </report> </reports> </reports>
Elements in the response:
Element | Attributes |
---|---|
|
|
Example of response JSON (list all available reports):
1 2{"expand":"reports","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/chart/reports"}, "reports":{"size":7,"max-result":7,"start-index":0,"report":[ {"key":"com.atlassian.bamboo.plugin.system.reports:numberOfBuilds","name":"Build Activity"}, {"key":"com.atlassian.bamboo.plugin.system.reports:averageDuration","name":"Build Duration"}, {"key":"com.atlassian.bamboo.plugin.system.reports:averageQueuedDuration","name":"Build Queued Duration"}, {"key":"com.atlassian.bamboo.plugin.myproject1:myproject1Coverage","name":"My Project 1 Code Coverage"}, {"key":"com.atlassian.bamboo.plugin.myproject1:myproject1LinesOfCode","name":"My Project 1 Lines of Code"}, {"key":"com.atlassian.bamboo.plugin.system.reports:numberOfFailures","name":"Number of Build Failures"}, {"key":"com.atlassian.bamboo.plugin.system.reports:numberOfTests","name":"Number of Tests"},
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Lists all the builds waiting in the build queue, adds or removes a build from the build queue. |
URI Parameters |
|
HTTP Methods |
|
Example command to trigger a build or delete it from the queue:
1 2curl -X POST --user admin:admin http://host:8085/rest/api/latest/queue/PLAN-KEY?os_authType=basic curl -X DELETE --user admin:admin http://host:8085/rest/api/latest/queue/PLAN-KEY?os_authType=basic
Example of response XML (retrieving builds in the build queue):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <queue expand="queuedBuilds"> <link rel="self" href="http://myhost:8085/rest/api/latest/queue"/> - <queuedBuilds expand="queuedBuild" size="1" max-result="1" start-index="0"> - <queuedBuild buildResultKey="MYPROJ1-MYPLAN1-7" buildNumber="7" planKey="MYPROJ1-MYPLAN1" expand="changes"> <triggerReason>Manual build</triggerReason> - <changes expand="change" size="1" max-result="1" start-index="0"> <change changesetId="98662" author="apowers"/> </changes> </queuedBuild> </queuedBuilds> </queue>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
| Description: Build trigger reason |
|
|
|
|
Example of response JSON:
1 2{"expand":"queuedBuilds","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/queue"}, "queuedBuilds":{"expand":"queuedBuild","size":1,"max-result":1,"start-index":0,"queuedBuild":[ {"buildResultKey":"MYPROJ1-MYPLAN1-7","buildNumber":7,"planKey":"MYPROJ1-MYPLAN1","expand":"changes","triggerReason":"Manual build", "changes": {"expand":"change","size":1,"max-result":1,"start-index":0,"change":[ {"changesetId":"98662","author":"apowers"} ]}} ]}}
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Retrieves the comments for a build result, adds a comment to a build result. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML (retrieving comments for a build result):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <comments expand="comments"> <link rel="self" href="http://myhost:8085/rest/api/latest/build/MYPROJ1-MYPLAN1-5/comment"/> - <comments expand="comment" size="1" max-result="1" start-index="0"> - <comment author="apowers"> <content>Groovy build result baby!</content> <creationDate>2009-09-11T22:35:34.436+0200</creationDate> <modificationDate>2009-09-11T22:35:34.436+0200</modificationDate> </comment> </comments> </comments>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
|
|
| Description: Content of the comment |
| Description: Creation date of the comment |
| Description: Last modified date of the comment |
Example of response JSON:
1 2{"expand":"comments","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/build/MYPROJ1-MYPLAN1-5/comment"},"comments": {"expand":"comment","size":1,"max-result":1,"start-index":0,"comment":[ {"author":"apowers", "content":"Groovy build result baby!", "creationDate":"2009-09-11T22:35:34.436+0200", "modificationDate":"2009-09-11T22:35:34.436+0200"} ]}}
Example of request XML (posting a comment to a build result):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <comment author="apowers"> <content>A build result comment.</content> </comment>
Elements in the request:
Element | Attributes |
---|---|
|
|
| Description: Content of the comment to be added to the build result |
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Retrieves the labels for a build result, adds or removes a label to a build result. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML (retrieving labels for a build result):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <labels expand="labels"> <link rel="self" href="http://myhost:8085/rest/api/latest/build/MYPROJ1-MYPLAN1-5/label"/> - <labels size="1" max-result="1" start-index="0"> <label name="label1"/> </labels> </labels>
Elements in the response:
Element | Attributes |
---|---|
|
|
|
|
|
|
Example of response JSON:
1 2{"expand":"labels","link":{"rel":"self","href":"http://myhost:8085/rest/api/latest/build/MYPROJ1-MYPLAN1-5/label"}, "labels":{"size":1,"max-result":1,"start-index":0,"label":[ {"name":"label1"} ]}}
Example of request XML (adding a label to a build result):
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <label name="label1" />
Elements in the request:
Element | Attributes |
---|---|
|
|
API reference for the latest Bamboo version is the recommended source of information on Bamboo REST APIs.
URI |
|
Description | Retrieves information about a Bamboo server. |
URI Parameters |
|
HTTP Methods |
|
Example of response XML:
1 2<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> - <info> <version>2.4</version> <edition/> <buildDate>2009-09-11T20:47:44.000+0200</buildDate> <buildNumber>1503</buildNumber> </info>
Elements in the response:
Element | Attributes |
---|---|
| Description: Bamboo version of server |
| Description: Server build date |
| Description: Server build number |
Example of response JSON:
1 2{"version":"2.4","edition":"","buildDate":"2009-09-11T20:47:44.000+0200","buildNumber":"1503"}
Rate this page: