Overview
Manually trigger a refresh of a report in Mode. This Blueprint will kick off the refresh. It will create and store the generated run ID to `shipyard-artifacts/mode-blueprints/variables/report_run_id.pickle`
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Token ID |
MODE_TOKEN_ID |
Password |
✅ |
None |
- |
The ID of the Token used to authenticate with Mode. |
|
Token Password |
MODE_TOKEN_PASSWORD |
Password |
✅ |
None |
- |
The Token Password associated to the Token ID used to authenticate with Mode. |
|
Workspace Name |
MODE_WORKSPACE_NAME |
Alphanumeric |
✅ |
None |
- |
Typically found in the URL structure as https://app.mode.com/ACCOUNT_NAME/ |
|
Report ID |
MODE_REPORT_ID |
Alphanumeric |
✅ |
None |
- |
Numeric ID of the report you want to download, typically found at the end of the URL. |
|
Wait For Completion |
MODE_WAIT |
Boolean |
➖ |
TRUE |
- |
Enable if you want this vessel to wait for the report to refresh before exiting |
YAML
Below is the YAML template
source:
template: Mode - Trigger Report Refresh
inputs:
MODE_TOKEN_ID:
MODE_TOKEN_PASSWORD:
MODE_WORKSPACE_NAME:
MODE_REPORT_ID:
MODE_WAIT: 'TRUE'
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 200
- 203
- 204