Learning Resources

✨ List or create modules for a learning resource

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> List or create modules for a learning resource.
post/api/learning-resources/{id}/modules/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/learning-resources/{id}/modules/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

A unique integer value identifying this learning resource.

Query parameters

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

scopestring
searchstring

A search term.

workspaceinteger

Request body

allow_standaloneboolean
colorstring nullable
cover_image_urlstring
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
hide_completed_quizzesboolean
single_page_reviewboolean nullable
summarystring
titlestring
workspaceinteger nullable

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

  • f1ccbdf55e1aRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

  • b5f055b9d45bRevision changes
    • breaking

      the response property /////// became nullable for the status

    • breaking

      the response property ///// became nullable for the status

    • breaking

      the response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to integer for status