Action usage examples

Examples give users ideas on actual usage. We use automation to generate, test, and run these actions, so names and combinations may be odd or repetitive . In many cases, other actions or environmental setup is required for the action to run, so you will need to adjust the action parameters and setup appropriate for your environment.

Command line environments can be different, especially between Windows and non-Windows systems. Our Tips page talks about command line escaping differences and there are differences with respect to environment variable references ($ for non-Windows and %...% for Windows). These differences can impact examples, so recognize and adjust for your platform. In particular, all examples here are run with the standard bash shell on Linux.

addBoardAdministrators

--action addBoardAdministrators --board "3605" --group "jira-developers" --userId "developer"

addBoardColumn

--action addBoardColumn --board "3605" --name "C1"

--action addBoardColumn --board "3605" --name "C2" --status "In Progress"

addIssuesToSprint

--action addIssuesToSprint --sprint "3850" --issue "ZCLISPRINTS-1"

--action addIssuesToSprint --sprint "3850" --jql "project = ZCLISPRINTS AND status != CLOSED"

addQuickFilter

--action addQuickFilter  --board "3605"  --filter "ZCLIBOARDS"  --description "Test Demo"  --jql "affectedVersion is not EMPTY"

completeSprint

--action completeSprint --sprint "3847"

--action completeSprint --sprint "3849"

copyBoard

--action copyBoard --board "3605" --name "ZCLIBOARDSY"

--action copyBoard --board "ZCLIBOARDSX"

createBoard

--action createBoard --name "ZCLIBOARDS" --type "kanban" --project "ZCLIBOARDS"

--action createBoard --name "ZCLIBOARDS" --type "scrum" --project "ZCLIBOARDS"

--action createBoard --name "ZCLISPRINTS" --type "kanban" --project "ZCLISPRINTS"

--action createBoard --name "ZCLISPRINTS" --type "scrum" --project "ZCLISPRINTS"

createSprint

--action createSprint --name "ZCLISPRINTSExample1" --board "3609"

--action createSprint  --name "ZCLISPRINTSExample2"  --board "3609"  --startDate "2021-01-01"  --endDate "2021-01-15"  --dateFormat "yyyy-MM-dd"

deleteBoard

--action deleteBoard --board "NOT_FOUND" --continue

--action deleteBoard --board "ZCLIBOARDS3"

--action deleteBoard --board "ZCLIBOARDSY" --deleteFilter

--action deleteBoard --board 1234567890 --continue

deleteSprint

--action deleteSprint --sprint "3849"

getBoard

--action getBoard --board "3605"

--action getBoard --board "3606"

--action getBoard --board "ZCLIBOARDS" --type "kanban"

--action getBoard --board "ZCLIBOARDS" --type "scrum"

getBoardColumnList

--action getBoardColumnList --board "3605"

getBoardList

--action getBoardList

--action getBoardList --regex "ZCLIBOARDS" --outputFormat 999

getClientInfo

--action getClientInfo

--action getClientInfo --outputFormat 2

getQuickFilter

--action getQuickFilter --board "3605" --filter "7551"

getQuickFilterList

--action getQuickFilterList --board "3605"

getSprint

--action getSprint --sprint "3849"

--action getSprint --sprint "ZCLISPRINTSExample1"

getSprintList

--action getSprintList --board "3609" --dateFormat "yyyy-MM-dd"

releaseVersion

--action releaseVersion  --board "3609"  --project "ZCLISPRINTS"  --version "CLI-LATEST"  --date "2021-01-31"  --dateFormat "yyyy-MM-dd"

removeBoardColumn

--action removeBoardColumn --board "3605" --column "C2"

--action removeBoardColumn --board "3605" --column "NOT_FOUND" --continue

removeQuickFilter

--action removeQuickFilter --board "3605" --filter "ZCLIBOARDSX"

run

--action run  --common "--board 3609"  --input "-a createSprint --name ZCLISPRINTS"  --input "-a createSprint --name ZCLISPRINTS --options createAnother"  --input "-a createSprint --name ZCLISPRINTS --continue"  --input "-a createSprint"  --input "-a createSprint"  --input "-a createSprint --name ZCLISPRINTS1 --startDate 2021-01-01 --endDate 2021-01-15 --dateFormat yyyy-MM-dd"  --input "-a createSprint --name ZCLISPRINTS2 --startDate 2021-01-01 --endDate 2021-01-15"  --input "-a createSprint --name ZCLISPRINTS3"  --input "-a createSprint --name ZCLISPRINTS4"  --input "-a createSprint --name ZCLISPRINTS5"  --input "-a createSprint --name ZCLISPRINTS6"  --input "-a getSprintList"

--action run  --common "--project ZCLIBOARDS --type scrum"  --input "-a createBoard --name ZCLIBOARDS1"  --input "-a createBoard --name ZCLIBOARDS1 --continue"  --input "-a createBoard --name ZCLIBOARDS1 --options createAnother"  --input "-a createBoard --name ZCLIBOARDS2"  --input "-a createBoard --name ZCLIBOARDS3"  --input "-a getBoardList"

--action run  --file "/opt/atlassian/pipelines/agent/build/src/itest/agile/resources/kanban-board-config-template.txt"  --common "--board 3606"  --continue

--action run  --file "/opt/atlassian/pipelines/agent/build/src/itest/agile/resources/scrum-board-config-template.txt"  --common "--board 3605"  --continue

--action run  --input "-a deleteSprint --sprint 3847"  --input "-a deleteSprint --sprint 3848"  --input "-a deleteSprint --sprint 3848 --continue"  --input "-a getSprintList --board 3609"

--action run  --input "-a updateSprint --sprint 3843 --name zzSprint1a"  --input "-a updateSprint --sprint 3847 --name ZCLISPRINTS6"  --input "-a updateSprint --sprint 3844 --endDate 2021-01-31 --dateFormat yyyy-MM-dd"  --input "-a updateSprint --sprint 3845 --state active --startDate 2021-01-01 --endDate 2021-01-15 --dateFormat yyyy-MM-dd"  --input "-a completeSprint --sprint 3845"  --input "-a startSprint --sprint ZCLISPRINTS4 --startDate 2021-01-01 --endDate 2021-01-15"  --input "-a completeSprint --sprint ZCLISPRINTS4"  --input "-a startSprint --sprint 3847 --startDate 2021-01-01 --endDate 2021-01-15"  --input "-a getSprintList --board 3609"

runFromBoardList

--action runFromBoardList --limit 1 --regex "ZCLIBOARDS" --common "-a getBoard --board @boardId@"

runFromQuickFilterList

--action runFromQuickFilterList  --board "3605"  --limit 1  --regex "ZCLIBOARDS"  --common "-a getReplacementVariableList"

runFromSprintList

--action runFromSprintList --board "3609" --common "--action getReplacementVariableList"

setBoardAdministrators

--action setBoardAdministrators --board "3605" --group "jira-administrators" --userId "automation"

startSprint

--action startSprint --sprint "3849"

updateBoard

--action updateBoard --board "3605" --estimation "Story Points" --tracking "Remaining Time Estimate"

--action updateBoard --board "3605" --filter "Filter for project ZCLIBOARDS"

--action updateBoard --board "3605" --name "ZCLIBOARDSX"

--action updateBoard --board "3606" --subquery "fixVersion is NOT EMPTY"

updateBoardCard

--action updateBoardCard --board "3605" --field "Assignee" --cardType "backlog"

--action updateBoardCard --board "3605" --field "Creator" --cardType "sprint" --options "enableDaysInColumn"

--action updateBoardCard --board "3605" --field "Sprint" --cardType "@all" --options "disableDaysInColumn"

--action updateBoardCard --board "3606" --field "Sprint" --options "enableDaysInColumn"

updateBoardColumn

--action updateBoardColumn --board "3605" --column "C1" --name "C1A" --status "In Progress,CLOSED"

updateQuickFilter

--action updateQuickFilter --board "3605" --filter "7551" --name "ZCLIBOARDSX" --jql "assignee is not EMPTY"

updateSprint

--action updateSprint --sprint "3849" --startDate "2021-01-01" --endDate "2021-01-15" --dateFormat "yyyy-MM-dd"