Developing a new studio experience

Tyrus · June 16, 2020, 6:02pm

I need to build a custom tool so an instructional designer can outline a course that is separated from Studio. When the Outline is ready, it can be pushed to Studio for the rest of the content edition. I’ve noticed that studio is able to create sections, subsections using apparently undocumented POST calls to http://localhost:18010/xblock/

Is there any documentation on that? If not, any directions to the code that handle that?
The idea is eventually to have a full new UX that can do outline and content editing only using the Studio back end. Would that be possible at all?

antoviaque · June 29, 2020, 8:03am

@Tyrus Rather than making calls to internal Studio APIs, you might want to look into using the course import API, which would allow you to import a complete course structure, which is a well defined and stable format. See:

github.com

edx/edx-platform/blob/61e1eda20df2825a409db3e2d36c69d7c36d3e2d/cms/djangoapps/contentstore/api/views/course_import.py#L43


    """
    def perform_authentication(self, request):
        """
        Ensures that the user is authenticated (e.g. not an AnonymousUser)
        """
        super(CourseImportExportViewMixin, self).perform_authentication(request)
        if request.user.is_anonymous:
            raise AuthenticationFailed


class CourseImportView(CourseImportExportViewMixin, GenericAPIView):
    """
    **Use Case**

        * Start an asynchronous task to import a course from a .tar.gz file into
        the specified course ID, overwriting the existing course
        * Get a status on an asynchronous task import

    **Example Requests**

        POST /api/courses/v0/import/{course_id}/

Some discussions about course exports/imports at:

Topic		Replies	Views
Course content creation flow Authoring api , how-to	2	586	December 16, 2020
Course modes creation through Studio Development	2	904	July 27, 2021
How to get the source code for xblock API for creating course structures(sections/subsections etc) Development api , how-to , tutor , studio , olive	1	320	June 30, 2023
Integrating open edx with another django app Development	6	1522	September 28, 2021
Grant course creation and extract APIs Site Operations Help	1	386	October 26, 2020

Developing a new studio experience

Related topics