I’m trying to use XBlock REST API endpoints listed in swagger API docs. None of them seems to work since I am getting ‘Opaque key does not have a learning context’ error. I have read edx docs about ‘Usage Id’ which seems to be the same to {usage_key_str} mentioned in swagger. And my {usage_key_str…

Hi @alexB , Most likely you are trying to use the “new” XBlock API , and your guess is correct - that API only works with a subset of XBlocks, namely those stored in Blockstore. So currently that means it only works with XBlocks in Content Libraries v2, whose IDs/keys start with lb: If you are tryin…

Hi @braden , thank you for your answer. What I’m trying to do is slightly customize default xblocks (e.g. replace assessment input components with my own). I thought it would be nice to fetch olx or at least html of specific xblock, parse it somehow and display it the way I need. Unfortunately, th…

Hi @alexB , if you request the student_view_data from the course blocks API, it will return a JSON object which contains the data that you need to power your own UI. This is the same information that the mobile app uses to display a native UI for some XBlock types on mobile. However, that approach re…

Hello @alexB I’m looking to do something similar; a rest api that returns the params on the Edit screen of an lti_consumer xblock. If you find something, or come up with something yourself please let us know. I’ll do the same. Thanks David

Hello, is there a simple way to access the answers and metadata of the polls and surveys responded by learners ? Thanks. Amaury

Looking through the rest API docs, this might be your best bet: https://docs.openedx.org/projects/edx-platform/en/latest/references/lms_apis.html#post--instructor-v1-reports-course_id-generate-problem_responses

XBlock REST API

Development

alexB (Alexander Black) May 20, 2022, 2:10pm 5

Thank you, @braden.
student_view_data in blocks API is something I was looking for.
Sadly, according to your post there is no support for problem blocks, which is important for me.
Will be looking for other workarounds.

Topic		Replies	Views
How to access details of the course and the xblocks within a course Development	1	591	April 21, 2020
How to get the source code for xblock API for creating course structures(sections/subsections etc) Development api , how-to , tutor , studio , olive	1	412	June 30, 2023
How to return json response of video, presentation and pdf of course section instead of html fragment Development api , devstack	3	769	June 18, 2021
Identify xblocks used on specific pages Development	3	727	February 14, 2025
How to get course content in xblock Site Operations Help	1	303	September 16, 2021

XBlock REST API

Related topics