Bamboo is not getting build variables from path variables

Summary

Bamboo extends functionality to integrate with third-party services, one of which is Service Now. Such integrations are able to automate the running of builds. Bamboo queue API allows Services to pass Bamboo variables as URL path variables, and if these variables are incorrectly formatted Bamboo will not consume them therefore causing the build to fail.

Environment

Bamboo Datacenter

Diagnosis

1. Confirm that your build-required environmental variables are defined based on Bamboo variable definition i.e. bamboo.variable.{VARIABLE_NAME}.

2. Add the first task called Dump variables to log

3. Run a new build using the API endpoint

   1 2 3 4 5 # /rest/api/latest/queue/{PROJECT_KEY}-{PLAN_KEY} curl --location --request POST 'http://localhost:8085/rest/api/latest/queue/BP-TPFPRV?bamboo.variable.BUILD_SEQ_NUMBER=350i424&bamboo.variable.BUILD_MARKER=3400984&bamboo.variable.BUILD_STARTEDBY=admin_user' \ --header 'Authorization: Bearer YWRtaW46ZWVlZWVlMjI=' \

   • Bamboo build log shows the variables dumped as part of Bamboo variables for that build. If the variables were added correctly as path variables, the variables will be logged in the dump log.

     1 2 3 4 5 6 simple 24-Nov-2023 02:29:14 ---- DUMPING VARIABLES TO LOG --- simple 24-Nov-2023 02:29:14 key: [BUILD_MARKER] value: [3400984] type: MANUAL simple 24-Nov-2023 02:29:14 key: [BUILD_SEQ_NUMBER] value: [350i424] type: MANUAL simple 24-Nov-2023 02:29:14 key: [BUILD_STARTEDBY] value: [admin_user] type: MANUAL simple 24-Nov-2023 02:29:14 key: [ManualBuildTriggerReason.userName] value: [admin] type: CUSTOM simple 24-Nov-2023 02:29:14 key: [agentId] value: [1703937] type: CUSTOM

   • You can also find them on the build summary page;

     • 

Solution

When using Bamboo variables, follow the instructions on how to use variables described in Bamboo variables.