Learning Resources

✨ Get a learning resource

get/api/learning-resources/{id}/

Path parameters

idinteger required

A unique integer value identifying this learning resource.

Response

allow_standaloneboolean
colorstring nullable
contentobject required
content_versioninteger required
cover_image_urlstring
created_atstring date-time required
default_allow_manual_accessboolean
default_gate_annotator_data_managerboolean nullable
default_gate_annotator_label_streamboolean nullable
default_gate_reviewer_data_managerboolean nullable
default_gate_reviewer_label_streamboolean nullable
default_gate_reviewer_review_streamboolean nullable
estimated_duration_unit'minutes' | 'hours' | 'days' | 'weeks'
  • minutes - Minutes
  • hours - Hours
  • days - Days
  • weeks - Weeks
estimated_duration_valueinteger nullable
generate_certificate_on_completionboolean
has_unpublished_changesboolean nullable required
hide_completed_quizzesboolean
idinteger required
is_publishedboolean required
learner_contentobject nullable required
learner_countinteger required
learners_completed_countinteger required
learners_started_countinteger required
module_countinteger required
organizationinteger required
page_countinteger required
progressobject nullable required
project_assignmentsobject[] required
project_countinteger required
single_page_reviewboolean nullable
structure_versioninteger required
summarystring
titlestring
unpublished_module_idsinteger[] required
updated_atstring date-time required
workspaceinteger nullable

Changes

Changed in 8 of the 97 revisions of this API.16110

    • added the optional property single_page_review to the response with the 200 status

      response-optional-property-added

    • added the required property structure_version to the response with the 200 status

      response-required-property-added

    • the response property created_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • the response property modules/items/updated_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • the response property progress became nullable for the status 200

      response-property-became-nullable

    • the response property updated_by/allOf[UserSimple]/avatar became nullable for the status 200

      response-property-became-nullable

    • the content response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • the learner_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the learners_completed_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the learners_started_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the module_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the modules/items/page_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the page_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the progress response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • the project_assignments response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • the project_count response's property type/format changed from string/ to integer/ for status 200

      response-property-type-changed

    • the unpublished_module_ids response's property type/format changed from string/ to array/ for status 200

      response-property-type-changed

    • for the path request parameter id, the type/format was changed from string/ to integer/

      request-parameter-type-changed

    • added the required property modules/items/updated_by to the response with the 200 status

      response-required-property-added

  • 77f50e3ef22015See the full diff
    • removed the optional property default_gate_before_first_annotation from the response with the 200 status

      response-optional-property-removed

    • added the optional property default_gate_annotator_data_manager to the response with the 200 status

      response-optional-property-added

    • added the optional property default_gate_annotator_label_stream to the response with the 200 status

      response-optional-property-added

    • added the optional property default_gate_reviewer_data_manager to the response with the 200 status

      response-optional-property-added

    • added the optional property default_gate_reviewer_label_stream to the response with the 200 status

      response-optional-property-added

    • added the optional property default_gate_reviewer_review_stream to the response with the 200 status

      response-optional-property-added

    • added the required property learner_content to the response with the 200 status

      response-required-property-added

    • endpoint added

      endpoint-added

Of the 97 revisions, 1 has no diff computed.