Plan status isActive vs isBuilding

One can call following RestAPI to get Plan Detail

 


curl --user 'xxx':'xxx' -H "Accept: application/json" -X GET 'http://localhost:8085/rest/api/latest/plan/PRJ-PLANKEY2'


{"expand":"actions,stages,branches,variableContext","projectKey":"PRJ","projectName":"Project Name","project":{"key":"PRJ","name":"Project Name","description":"","link":{"href":"http://localhost:8085/rest/api/latest/project/PRJ","rel":"self"}},"description":"Plan created from (enter repository url of your plan)","shortName":"Plan2","buildName":"Plan2","shortKey":"PLANKEY2","type":"chain","enabled":true,"link":{"href":"http://localhost:8085/rest/api/latest/plan/PRJ-PLANKEY2","rel":"self"},"isFavourite":false,"isActive":true,"isBuilding":true,"averageBuildTimeInSeconds":5.0,"actions":{"size":7,"start-index":0,"max-result":7},"stages":{"size":2,"start-index":0,"max-result":2},"branches":{"size":0,"start-index":0,"max-result":0},"variableContext":{"size":1,"max-results":1},"key":"PRJ-PLANKEY2","name":"Project Name - Plan2","planKey":{"key":"PRJ-PLANKEY2"}}

 

What is the difference between Plan isActive and isBuilding? 

If one want to find out if a Plan is running, which of these 2 parameter best fit the requirement? 

 

Thanks!

 

 

 

1 answer

1 accepted

0 vote

Hi Lei,

"isActive" - means that the build has been triggered.

"isBuilding" - means build execution has been started and the agent is executing it.

So "isBuilding" will be the best fit for your requirement.

 

To test the above:

1. Disable all the agents in the Bamboo.

2. Trigger the build.

<Result> - Since there is no agent to execute the build the "isActive" will become "true" and "isBuilding" will be "false"

 

1. Enable the agents and run the build again

<Result> - Both "isActive" and "isBuilding" will be "true"

 

Hope this will help.

 

Thanks,

Robhit

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Published May 18, 2017 in Bamboo

FAQ: How to Upgrade Bamboo Server

Bamboo 5.9 will no longer be supported after June 12, 2017. What does this mean? As part of our End of Life policy, Atlassian supports major versions for two years after the first major iteratio...

1,561 views 0 6
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you