Added documentation for exporting saved Metric Explorer charts with the XDMoD API #1907
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aestoltm
requested review from
eiffel777,
jpwhite4,
ryanrath,
aaronweeden and
connersaeli
connersaeli
reviewed
Aug 22, 2024
connersaeli
reviewed
Aug 23, 2024
ryanrath
requested changes
Aug 23, 2024
ryanrath
previously approved these changes
Aug 23, 2024
aaronweeden
requested changes
Sep 5, 2024
|
@aaronweeden Updated per your feedback. You can now export either a single chart or all your saved charts to a specified path. |
aaronweeden
requested changes
Sep 5, 2024
Closed
3 tasks
aaronweeden
requested changes
Dec 2, 2024
| chart_name = f"{chart['name']}.{image_format}" if ('name' in chart) else f"xdmod_API_export_{idx}.{image_format}" | ||
|
|
||
| with open(export_dir + '/' + chart_name, "wb") as f: | ||
| f.write(chart_response.content) |
There was a problem hiding this comment.
Suggested change
| f.write(chart_response.content) | |
| f.write(chart_response.content) | |
| print('Wrote ' + export_dir + '/' + chart_name) |
docs/howto-api-image-export.md
Outdated
Comment on lines
85
to
95
| chart_json['operation'] = "get_data" | ||
| chart_json['controller_module'] = "metric_explorer" | ||
| chart_json['show_title'] = "y" | ||
| chart_json['format'] = image_format | ||
| chart_json['width'] = width | ||
| chart_json['height'] = height | ||
|
|
||
| chart_response = session.post(f'{site_address}/controllers/metric_explorer.php', data=chart_json, headers=header) | ||
| chart_name = f"{chart['name']}.{image_format}" if ('name' in chart) else f"xdmod_API_export_{idx}.{image_format}" | ||
|
|
||
| with open(export_dir + '/' + chart_name, "wb") as f: |
There was a problem hiding this comment.
Suggested change
| chart_json['operation'] = "get_data" | |
| chart_json['controller_module'] = "metric_explorer" | |
| chart_json['show_title'] = "y" | |
| chart_json['format'] = image_format | |
| chart_json['width'] = width | |
| chart_json['height'] = height | |
| chart_response = session.post(f'{site_address}/controllers/metric_explorer.php', data=chart_json, headers=header) | |
| chart_name = f"{chart['name']}.{image_format}" if ('name' in chart) else f"xdmod_API_export_{idx}.{image_format}" | |
| with open(export_dir + '/' + chart_name, "wb") as f: | |
| chart_json['operation'] = 'get_data' | |
| chart_json['controller_module'] = 'metric_explorer' | |
| chart_json['show_title'] = 'y' | |
| chart_json['format'] = image_format | |
| chart_json['width'] = width | |
| chart_json['height'] = height | |
| chart_response = session.post(f'{site_address}/controllers/metric_explorer.php', data=chart_json, headers=header) | |
| chart_name = f"{chart['name']}.{image_format}" if ('name' in chart) else f'xdmod_API_export_{idx}.{image_format}' | |
| with open(export_dir + '/' + chart_name, 'wb') as f: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This documentation contains a Python script that uses the XDMoD API to authenticate with a local XDMoD account for the given credentials and site URL. Then the script will export the saved Metric Explorer charts into the current working directory. This documentation also describes how to edit certain parts of the script and where to find more information about the request schema for the request that exports the images.
Motivation and Context
We received a ticket asking about using the XDMoD API to export saved images for an Open XDMoD - Open OnDemand integration. This documentation will be used with the response and for future tickets that refer to issues about exporting images with the XDMoD API.
Tests performed
Tested script locally.
Checklist: