Edit


 


Agile Client Examples

Owned by Jonathan Muse
Last updated: Nov 18, 2024
3 min read

Action usage examples

addBoardAdministrators

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

addBoardColumn

--action addBoardColumn --board "3761" --name "C1"

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

addIssuesToSprint

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

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

addQuickFilter

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

completeSprint

--action completeSprint --sprint "3988"

--action completeSprint --sprint "3990"

copyBoard

--action copyBoard --board "3761" --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 "3767"

--action createSprint --name "ZCLISPRINTSExample2" --board "3767" --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 "3990"

getBoard

--action getBoard --board "3761"

--action getBoard --board "3762"

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

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

getBoardColumnList

--action getBoardColumnList --board "3761"

getBoardList

--action getBoardList

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

getClientInfo

--action getClientInfo

--action getClientInfo --outputFormat 2

getQuickFilter

--action getQuickFilter --board "3761" --filter "7871"

getQuickFilterList

--action getQuickFilterList --board "3761"

getSprint

--action getSprint --sprint "3990"

--action getSprint --sprint "ZCLISPRINTSExample1"

getSprintList

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

releaseVersion

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

removeBoardColumn

--action removeBoardColumn --board "3761" --column "C2"

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

removeQuickFilter

--action removeQuickFilter --board "3761" --filter "ZCLIBOARDSX"

run

--action run --common "--board 3767" --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 3762" --continue

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

--action run --input "-a deleteSprint --sprint 3988" --input "-a deleteSprint --sprint 3989" --input "-a deleteSprint --sprint 3989 --continue" --input "-a getSprintList --board 3767"

--action run --input "-a updateSprint --sprint 3984 --name zzSprint1a" --input "-a updateSprint --sprint 3988 --name ZCLISPRINTS6" --input "-a updateSprint --sprint 3985 --endDate 2021-01-31 --dateFormat yyyy-MM-dd" --input "-a updateSprint --sprint 3986 --state active --startDate 2021-01-01 --endDate 2021-01-15 --dateFormat yyyy-MM-dd" --input "-a completeSprint --sprint 3986" --input "-a startSprint --sprint ZCLISPRINTS4 --startDate 2021-01-01 --endDate 2021-01-15" --input "-a completeSprint --sprint ZCLISPRINTS4" --input "-a startSprint --sprint 3988 --startDate 2021-01-01 --endDate 2021-01-15" --input "-a getSprintList --board 3767"

runFromBoardList

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

runFromQuickFilterList

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

runFromSprintList

--action runFromSprintList --board "3767" --common "--action getReplacementVariableList"

setBoardAdministrators

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

startSprint

--action startSprint --sprint "3990"

updateBoard

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

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

--action updateBoard --board "3761" --name "ZCLIBOARDSX"

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

updateBoardCard

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

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

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

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

updateBoardColumn

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

updateQuickFilter

--action updateQuickFilter --board "3761" --filter "7871" --name "ZCLIBOARDSX" --jql "assignee is not EMPTY"

updateSprint

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

 

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.