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.

exportData

--action exportData  --file "build/output/export/exportDataFreeStarterTier.txt"  --vendor 90  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "FREE_STARTER_TIER"  --startDate "2021-09-01"  --outputType "json"  --pretty  --options "includeAtlassianLicenses"

--action exportData  --file "build/output/export/exportDataLicenseEventsChurn.txt"  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "license_events"  --type "churn"  --endDate "2021-12-31"

--action exportData  --file "build/output/export/exportDataLicenseEventsConversions.txt"  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "license_events"  --type "conversion"  --endDate "2021-12-31"  --outputType "json"  --pretty

--action exportData  --file "build/output/export/exportDataLicenseEventsRenewals.txt"  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "license_events"  --type "renewals"  --endDate "2021-12-31"  --outputType "json"  --pretty

--action exportData  --file "build/output/export/exportDataLicenses.txt"  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "licenses"  --startDate "2021-09-01"  --endDate "2022-01-31"  --options "withDataInsights"  --options "includeAtlassianLicenses"

--action exportData  --file "build/output/export/exportDataTransactions.txt"  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "TRANSACTIONS"  --startDate "2022-09-01"  --endDate "2023-07-31"  --outputType "json"  --pretty

--action exportData  --vendor "1221170"  --app "org.swift.confluence.markdown"  --hosting "cloud"  --exportType "feedback"  --endDate "2021-12-31"

--action exportData  --vendor "1221170"  --exportType "licenses"  --endDate "2012-08-01"  --columns "addonLicenseId,hostlicenseId,licenseId,addonKey,licensetype,maintenanceStartDate,maintenanceEndDate"  --outputType "text"  --options "tableNoWrap"

getApp

--action getApp --app "com.appfire.confluence.marketplace-test" --outputType "json" --pretty

--action getApp --app "com.atlassian.upm.atlassian-universal-plugin-manager-plugin"

--action getApp --vendor "1221170" --app "Confluence Command Line Interface (CLI)"

--action getApp --vendor "1221170" --app "confluence.cli"

--action getApp --vendor "1221170" --app "org.swift.confluence.acli" --dateFormat "yyyy-MM-dd"

--action getApp --vendor "1221170" --app "org.swift.confluence.table" --dateFormat "yyyy-MM-dd"

--action getApp --vendor "1221170" --app "org.swift.jira.cli" --dateFormat "yyyy-MM-dd"

--action getApp --vendor 90 --app "org.swift.confluence.word" --includeArchived --dateFormat "yyyy-MM-dd"

getAppFeedbackList

--action getAppFeedbackList  --vendor "1221170"  --outputType "text"  --limit 100  --options "includeAnonymous,tableNoWrap"

--action getAppFeedbackList  --vendor "1221170"  --outputType "text"  --options "reason=expensive,includeAnonymous,tableNoWrap"

--action getAppFeedbackList  --vendor 90  --app "org.swift.jira.cli"  --columns "-1,2,4"  --outputType "text"  --dateFormat "yyyy-MM-dd"  --options "tableNoWrap"

--action getAppFeedbackList  --vendor 90  --app "org.swift.jira.cli"  --columns "-1,2,4"  --outputType "text"  --dateFormat "yyyy-MM-dd"  --type "uninstall"  --options "tableNoWrap"  --options "includeAnonymous"  --options "reason=bugs"

--action getAppFeedbackList  --vendor 90  --app "org.swift.jira.cli"  --outputType "text"  --columns "feedback,license,type,app"  --regex ".+"  --options "tableNoWrap"

getAppList

--action getAppList --file "build/output/search/getAppListAll.txt" --searchType "all" --outputFormat 101

--action getAppList --search "who's looking" --outputFormat 2 --dateFormat "yyyy-MM-dd"

--action getAppList  --searchType "all"  --search "cli"  --application "confluence"  --hosting "cloud"  --outputFormat 101

--action getAppList --searchType "all" --search "org.swift" --outputFormat 101

--action getAppList  --searchType "all"  --search "sql"  --application "confluence"  --hosting "dataCenter"  --outputFormat 101

--action getAppList  --searchType "all"  --search "sql"  --application "confluence"  --hosting "server"  --outputFormat 101

--action getAppList --searchType "sales" --search "table" --application "confluence" --outputFormat 101

--action getAppList --searchType "sales" --search "table" --outputFormat 101

--action getAppList  --vendor "1221170"  --includeArchived  --columns "-description,-vendor name,summary"  --regex "org.swift.*"

--action getAppList  --vendor "1221170"  --lastUpdated "-30 day"  --columns "name,key,last modified"  --outputFormat 2  --dateFormat "yyyy-D"  --limit 5

--action getAppList  --vendor "1221170"  --outputFormat 2  --limit 1  --regex ".*jira.cli"  --dateFormat "yyyy-MM-dd'T'HH:mm:ss.SSSZ"

getAppPrivacyAndSecurity

--action getAppPrivacyAndSecurity --app "com.appfire.confluence.marketplace-test" --pretty

getApplicationList

--action getApplicationList

getInstallHistoryList

--action getInstallHistoryList --vendor "1221170" --app "org.swift.jira.cli" --type "" --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "active"  --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "appVersion"  --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "applicationMajorVersion"  --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "applicationMinorVersion"  --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "applicationVersion"  --startDate "2019-12-01"

--action getInstallHistoryList  --vendor "1221170"  --app "org.swift.jira.cli"  --type "version"  --startDate "2019-12-01"

getLicense

--action getLicense --vendor "1221170" --licenseId "SEN-20845082"

--action getLicense --vendor "1221170" --licenseId "SEN-6299015" --dateFormat "yyyy-MM-dd"

--action getLicense --vendor "1221170" --licenseId "SEN-L16417443"

--action getLicense --vendor "1221170" --licenseId "fc0e47cc-2e73-4227-a3d2-484bff9c2201"

--action getLicense --vendor "1221170" --licenseId "fe5cc017-7787-469c-9d87-1aa7c71b2961"

getLicenseList

--action getLicenseList --file "build/output/licenses/getLicenseList.txt" --vendor "1221170" --limit 150

--action getLicenseList  --file "build/output/licenses/getLicenseListVolume.txt"  --vendor "1221170"  --dateFormat "yyyy-MM-dd"  --limit 100  --dbTable "@default"  --dbTableKeys "license_id"  --dbCreateTable  --replace  --database "@database-test"

--action getLicenseList  --vendor "1221170"  --app "com.prcpo.confluence.plugins.secure-content-block"  --columns "license id,app,app name"  --outputType "table"  --limit 3

--action getLicenseList  --vendor "1221170"  --app "org.swift.jira.cot"  --limit 1000  --startDate "2020-12-01"  --endDate "2021-02-01"  --select "Evaluation License:L16417443"  --outputType "text"  --columns "1,3,5,6,7,Partner Contact Name,Channel,Evaluation Opportunity Size,Evaluation License,Evaluation Days To Convert,Evaluation Start Date,Evaluation End Date,Evaluation Sale Date"  --options "tableNoWrap"

--action getLicenseList  --vendor "1221170"  --app "org.swift.jira.cot"  --limit 1000  --startDate "2020-12-01"  --endDate "2021-02-01"  --select "Referrer Domain:learning.oreilly.com"  --outputType "text"  --columns "1,3,5,6,7,Channel,Campaign Name,Referrer Domain"  --options "tableNoWrap"

--action getLicenseList --vendor "1221170" --hosting "server" --limit 300

--action getLicenseList  --vendor "1221170"  --startDate "2021-01-02"  --endDate "2021-01-03"  --columns "license id,app,app name,maintenance start date"  --outputType "table"

getPrice

--action getPrice --vendor "1221170" --app "bamboo.cli" --edition "0"

--action getPrice --vendor "1221170" --app "table" --edition "10 users"

--action getPrice --vendor "1221170" --app "table" --edition "unlimited"

getPriceList

--action getPriceList  --app "com.appfire.confluence.marketplace-test"  --hosting "@all"  --category "pending"  --columns "app,hosting,category,unitcount,amount,monthsvalid"  --outputType "text"  --options "tableNoWrap"

--action getPriceList  --file "build/output/prices/getPriceListAll.txt"  --vendor "1221170"  --app "@ALL"  --hosting "@all"

--action getPriceList  --vendor "1221170"  --app "org.swift.jira.cli"  --hosting "@all"  --columns "-1,2,4,8,9,10,15"  --outputType "text"  --options "tableNoWrap"

--action getPriceList  --vendor "1221170"  --app "org.swift.jira.cli"  --hosting "datacenter"  --columns "-1,2,4,8,9,10,15"  --outputType "text"  --options "tableNoWrap"

--action getPriceList --vendor "1221170" --app "table"

getPricingInfo

--action getPricingInfo --vendor "1221170" --app "table" --dateFormat "yyyy-MM-dd" --hosting "datacenter"

getReview

--action getReview --app "org.swift.jira.cli" --reviewId "1974625" --dateFormat "yyyy-MM-dd"

getReviewList

--action getReviewList --app "org.swift.jira.cli" --dateFormat "yyyy-MM-dd"

--action getReviewList  --app "org.swift.jira.cli"  --dateFormat "yyyy-MM-dd"  --columns "-1,2,4,7"  --outputType "table"  --regex ".*((Dale Keller)|(extremely grateful)|(4-star review)).*"

--action getReviewList  --app "org.swift.jira.cli"  --dateFormat "yyyy-MM-dd"  --columns "helpful votes,app,review,response"  --outputType "text"  --options "sort=helpful"  --limit 3

getSalesMetricList

--action getSalesMetricList --vendor "1221170" --startDate "2019-09-01" --endDate "2019-10-01"

--action getSalesMetricList --vendor "1221170" --type "churn" --startDate "2019-01-01"

--action getSalesMetricList  --vendor "1221170"  --type "churn"  --startDate "2020/01"  --dateFormat "yyyy/MM"  --app "org.swift.jira.cli"  --columns "-1,2,4,6,7,8"  --outputType "table"

--action getSalesMetricList  --vendor "1221170"  --type "churn"  --startDate "30 01 2020"  --dateFormat "dd MM yyyy"  --columns "-1,2,4"  --options "aggregation=weekly"

--action getSalesMetricList --vendor "1221170" --type "conversions" --startDate "2019-09-01" --endDate "2019-10-01"

--action getSalesMetricList  --vendor "1221170"  --type "conversions"  --startDate "2019-12-01"  --endDate "2020-03-01"  --options "aggregation=week"  --columns "-1,2,4"  --outputType "table"  --regex "((@all)|(org.swift.*))"

--action getSalesMetricList  --vendor "1221170"  --type "conversions"  --startDate "2020-01-01"  --regex ".*((@all)|(jira.cli)).*"  --columns "-1,2,4,6,7,8"  --outputType "table"

--action getSalesMetricList --vendor "1221170" --type "renewals" --startDate "2019-09-01" --endDate "2019-10-01"

getTagList

--action getTagList --outputType "text"

--action getTagList --outputType "text" --select "type:CATEGORY"

getTransaction

--action getTransaction --vendor 90 --transactionId "AT-126720839" --dateFormat "yyyy-MM-dd"

--action getTransaction --vendor 90 --transactionId "AT-12760486" --dateFormat "yyyy-MM-dd"

getTransactionList

--action getTransactionList --file "build/output/transactions/getTransactionList.txt" --vendor "1221170" --limit 150

--action getTransactionList  --file "build/output/transactions/getTransactionListUpdate.txt"  --vendor "1221170"  --dateFormat "yyyy-MM-dd"  --limit 10  --lastUpdated "2024-03-17"  --dbTable "@default"  --dbTableKeys "transaction_id, license_id"  --database "@database-test"

--action getTransactionList  --file "build/output/transactions/getTransactionListVolume.txt"  --vendor "1221170"  --limit 10  --dbTable "@default"  --dbTableKeys "transaction_id, license_id"  --dbCreateTable  --replace  --database "@database-test"

--action getTransactionList --vendor "1221170" --dateFormat "yyyy-MM-dd" --hosting "server" --limit 10

--action getTransactionList  --vendor 90  --app "com.prcpo.confluence.plugins.secure-content-block"  --columns "transaction id,license id,app,app name"  --outputType "table"  --limit 3

--action getTransactionList  --vendor 90  --dateFormat "yyyy-MM-dd"  --startDate "2019-01-01"  --endDate "2019-01-05"  --columns "license id,app,app name,sale date"  --outputType "table"

getVendor

--action getVendor --vendor "1221170"

--action getVendor --vendor "@appfire"

--action getVendor --vendor "Appfire"

--action getVendor --vendor 90

getVendorContactList

--action getVendorContactList --vendor 90 --outputType "text" --columns "-1,2,5,6" --options "tableNoWrap"

--action getVendorContactList  --vendor 90  --regex "bob@.*"  --outputType "text"  --columns "1,2,3,4,5,6"  --options "tableNoWrap"

getVendorList

--action getVendorList --limit 10 --hasPublicApps

--action getVendorList --options "own"

--action getVendorList --options "text=Bob Swift" --outputFormat 2 --dateFormat "yyyy-MM-dd"

--action getVendorList --outputFormat 2 --limit 4 --hasPublicApps

--action getVendorList --regex ".*Appfire.*" --options "text=appfire"

getVersion

--action getVersion --app "com.appfire.confluence.marketplace-test" --hosting "server" --includePrivate

--action getVersion --app "com.appfire.confluence.marketplace-test" --version "0.1.31" --outputType "json" --pretty

--action getVersion  --app "com.appfire.confluence.marketplace-test"  --version "@latest"  --hosting "datacenter"  --includePrivate  --outputType "json"  --pretty

--action getVersion --app "org.swift.jira.cli"

--action getVersion --app "org.swift.jira.cli" --hosting "datacenter"

--action getVersion --app "org.swift.jira.cli" --version "11.2.0"

--action getVersion --vendor "1221170" --app "atlassian.cli" --version "9900"

--action getVersion --vendor "1221170" --app "confluence.table" --version "700"

getVersionList

--action getVersionList  --app "com.appfire.confluence.marketplace-test"  --hosting "datacenter"  --includePrivate  --limit 3  --outputType "text"  --options "tableNoWrap"  --columns "App,Version,Version Name,eulaurl,vendorpurchaseurl,learnmoreurl,artifacturl"

--action getVersionList  --app "com.appfire.confluence.marketplace-test"  --hosting "server"  --includePrivate  --limit 3  --outputType "text"  --options "tableNoWrap"  --columns "App,Version,Version Name,Status,License,Payment Model,Documentation,Artifact URL,Release Date,Release Summary,Release Notes,Version Compatibility"

--action getVersionList  --app "org.swift.confluence.cli"  --hosting "cloud"  --columns "version, version name, cloud, server, data center"

--action getVersionList --app "org.swift.confluence.table" --columns "Version, Version Name, Release Date"

--action getVersionList --app "org.swift.confluence.table" --regex "7\\d{2}" --limit 9 --dateFormat "yyyy-MM-dd"

--action getVersionList --file "build/output/apps/getVersionListAll.txt" --vendor "1221170" --app "@ALL" --limit 100

--action getVersionList  --vendor "1221170"  --app "confluence.cli"  --hosting "datacenter"  --columns "version, version name, cloud, server, data center"

renderRequest

--action renderRequest  --file "build/output/info/renderRequestApplications.txt"  --url "https://marketplace.atlassian.com/rest/latest/applications"  --pretty  --quiet

--action renderRequest --file "build/output/info/renderRequestJira.txt" --url "/rest/1.0/applications/jira" --pretty

--action renderRequest --url "rest/2/vendors/1221170/reporting/licenses?offset=0&limit=1&order=desc" --pretty

run

--action run   -i "-a addAsset -f ../marketplace-test/build/libs/marketplace-test-0.1.0.jar"  -i "-a addVersion --app com.appfire.confluence.marketplace-test --version 0 --hosting datacenter --url @asset@  --field \"releaseSummary=release summary 0\" --field \"moreDetails=more details 0\""  -i "-a getVersion --app com.appfire.confluence.marketplace-test --hosting datacenter --includePrivate"  --simulate

--action run  --common "--app com.appfire.confluence.marketplace-test"  -i "-a updateFields --field \"/tags/category=[{\"id\": \"53e537ed-a1fd-48da-a3f4-dd9349112787\"}]\" --field \"/tags/keywords=[{\"id\": \"ce5f868e-015c-4324-b809-db485b1e0dc4\"}]\""  -i "-a getApp"  -i "-a updateFields --field \"/tags/category=[{\"id\": \"53e537ed-a1fd-48da-a3f4-dd9349112787\"},{\"id\": \"8eab9b45-97d4-4532-98f9-4f3c26e4484b\"}]\" --field \"/tags/keywords=[{\"id\": \"ce5f868e-015c-4324-b809-db485b1e0dc4\"},{\"id\": \"c8d16230-d27b-4929-ae29-54614426c54c\"}]\""  -i "-a getApp"  -i "-a getAppList --vendor 1221335 --regex com.appfire.confluence.marketplace-test --includePrivate --columns key,categories,keywords"

--action run  --common "--vendor 90"  --continue  --input "-a removeVendorContact  --name automation+test@appfire.com --continue"  --input "-a getVendorContactList --regex automation\\+test@appfire\\.com --columns \"-1,2,5,6\" --outputType text"  --input "-a addVendorContact  --name automation+test@appfire.com --role primary --permission view-usage-reports --permission manage-addon-details"  --input "-a getVendorContactList --regex automation\\+test@appfire\\.com --columns \"-1,2,5,6\" --outputType text"  --input "-a removeVendorContact  --name automation+test@appfire.com --continue"

--action run  --continue  -i "-a addAsset -f /opt/atlassian/pipelines/agent/build/src/itest/marketplace/resources/assets/marketplace-test-0.1.0.jar"  -i "-a getAsset  --name @asset@"  -i "-a removeAsset --name @asset@"  -i "-a addAsset -f /opt/atlassian/pipelines/agent/build/src/itest/marketplace/resources/assets/sql-32x32.png --type icon"  -i "-a getAsset  --name @asset@"  -i "-a removeAsset --name @asset@"

runAutomation

--action runAutomation  --directory "@acli-automations"  --name "partner-metrics-time-series"  --vendor "@appfire"  --dbSite "database-test"  --regex "org.swift.confluence.cli"  --endDate "2022-06-01"  --columns "-appname,reactivatedmrr,expansionmrr"

runFromAppList

--action runFromAppList  --vendor "1221170"  --common "--action getApp --vendor 1221170 --app @app@ --file build/output/apps/@app@.txt --append"  --clearFileBeforeAppend  --options "parallel=4"  --regex "org.swift.*"

runFromLicenseList

--action runFromLicenseList  --vendor "1221170"  --app "org.swift.jira.cot"  --limit 100  --startDate "2021-01-30"  --endDate "2022-02-01"  --input "-a getLicense --vendor 1221170 --licenseId @licenseId@"  --options "parallel=4"

runFromList

--action runFromList  --list "cloud,server,datacenter"  --common "-a exportData --vendor 1221170 --hosting @entry@ --exportType \"LICENSES\" --startDate 2021-01-01 -f null"

runFromReviewList

--action runFromReviewList  --app "org.swift.jira.cli"  --dateFormat "yyyy-MM-dd"  --quiet  --common "--quiet --app org.swift.jira.cli"  --input "-a getReview --reviewId @reviewId@"  --limit 3

runFromTransactionList

--action runFromTransactionList  --vendor "1221170"  --limit 150  --input "-a getTransaction --vendor 1221170 --transactionId @transactionId@"  --options "parallel"

runFromVendorList

--action runFromVendorList  --options "text=appfire"  --common "--action getAppList --vendor @vendor@ --file build/output/vendors/appList.csv --append"  --clearFileBeforeAppend

runFromVersionList

--action runFromVersionList  --app "com.appfire.confluence.marketplace-test"  --hosting "server"  --includePrivate  --limit 2  -i "-a getReplacementVariableList --outputType text"  -i "-a getVersion --app @app@ --version @version@ --note @versionName@"

--action runFromVersionList  --limit 2  --app "com.appfire.confluence.marketplace-test"  --hosting "datacenter"  --includePrivate  -i "-a updateFields --app @app@ --version @version@ --field /vendorLinks/eula=http://appfire.com/eula"

setPrice

--action setPrice  --app "com.appfire.confluence.marketplace-test"  --hosting "cloud"  --field "10=5"  --field "100=.5"  --field "250=.4"  --field "1000=.3"  --field "2500=.2"  --field "5000=.2"  --field "7500=.2"  --field "10000=.1"  --field "15000=.1"  --field "20000=.1"  --field "25000=.1"  --field "30000=.1"  --field "35000=.1"  --field "40000=.1"  --field "45000=.1"  --field "-1=.1"

--action setPrice  --app "com.appfire.confluence.marketplace-test"  --hosting "datacenter"  --field "500=500"  --field "1000=1000"  --field "2000=2000"  --field "3000=3000"  --field "4000=4000"  --field "5000=5000"  --field "10000=10000"  --field "11000=11000"  --field "12000=12000"  --field "13000=13000"  --field "14000=14000"  --field "15000=15000"  --field "20000=20000"  --field "25000=25000"  --field "30000=30000"  --field "35000=35000"  --field "40000=40000"  --field "-1=990000"

updateFields

--action updateFields  --app "com.appfire.confluence.marketplace-test"  --field "/tagLine=test tagline 94019"  --field "summary=test summary 94019"  --field "/tags/category=[{\"id\": \"53e537ed-a1fd-48da-a3f4-dd9349112787\"}]"

--action updateFields  --app "com.appfire.confluence.marketplace-test"  --version "0.1.31"  --field "/vendorLinks/learnMore=https://appfire.atlassian.net/wiki/display/MCLI?94019"  --field "/vendorLinks/documentation=https://appfire.atlassian.net/wiki/display/MCLI?94019"  --field "/vendorLinks/eula=http://appfire.com/eula"

--action updateFields  --app "com.appfire.confluence.marketplace-test"  --version "@latest"  --hosting "datacenter"  --includePrivate  --field "/vendorLinks/learnMore=https://appfire.atlassian.net/wiki/display/MCLI?94019"  --field "/vendorLinks/documentation=https://appfire.atlassian.net/wiki/display/MCLI?94019"  --field "/vendorLinks/eula=http://appfire.com/eula"