How to determine fields for addTask

On this page

Summary

The addTask action can be used to add arbitrary tasks to a job. However, you must know the parameter fields that each task uses and needs. Normally, the task provider doesn't document this. However, they can be discovered. We have documented some examples already - see Examples for AddTask action. If the task you want is not already documented, then you need to discover the fields needed.  There are 2 ways to discover these fields.

  1. Using exportPlan on an existing plan that has been created manually through the UI.
  2. Using browser tools to discover fields from the UI. I use Crome → Developer Tools to look at the request details when you save a task from the UI.

Steps using exportPlan

Steps using UI 

Alternative for getting field names

An alternative approach you can use is to use your browsers Inspect Element support to get the name of fields from the UI. Click on the input field, right click -> Inspect Element and look for the name of the field.

Examples


On this page

The addTask action can be used to add arbitrary tasks to a job. However, you must know the parameter fields that each task uses and needs. Normally, the task provider doesn't document this. The following gives some examples. If the task you want is not one of the examples, the parameters can be discovered: see How to determine fields for addTask. If you get errors, you will need to debug the field problem by using the url used by the CLI tool in a browser so the errors are more prevalent. Run the action with --verbose and look for url that is being used and failing. This is the best that can be done until Bamboo provides proper REST APIs to help with this scenario.


Your task not listed yet?

Contribute your validated configuration by asking and answering your own question!