Qodex.ai

Sunbird Framework API(s)

Number of APIs: 15

The Framework API resources is basically a supporting data structure which serves as a template

  • It can be used in places where the structure remains the same but only the usage changes as per the requirement.

  • These resources are used to create, update, read, search, the objects like channels, frameworks, catergories, terms

  • The Hierarchy is as: FrameworkCategoryTerms

    • Category: An abstract classification of the terms partitioned according to requirement
    • Terms: Refers to a keyword or a phrase to descibe a Concept

  • TestCases

  1. framework/v1-framework-v3 - retire a framework GET {{baseUrl}}/framework/v3/retire/{{frameworkId}}

  2. framework/v1-framework - Create a Framework POST {{baseUrl}}/framework/v1/create

  3. framework/v1-framework - Publish Framework POST {{baseUrl}}/framework/v1/publish/{{frameworkId}}

  4. framework/v1-framework - Asset Create Copy POST {{baseUrl}}/asset/v1/create

  5. framework/v1-framework - Copy Framework POST {{baseUrl}}/framework/v1/copy/{{frameworkId}}

  6. framework/v1-category-v3 - Retire Category DELETE {{baseUrl}}/framework/v3/category/retire/:category

  7. framework/v1-category - Fetch Category GET {{baseUrl}}/framework/v1/category/read/{{categoryCode}}?framework={{frameworkId}}

  8. framework/v1-category - Update Category PATCH {{baseUrl}}/framework/v1/category/update/{{categoryCode}}?framework={{frameworkId}}

  9. framework/v1-term - Fetch Term GET {{baseUrl}}/framework/v1/term/read/{{termCode}}?framework={{frameworkId}}&category={{categoryId}}

  10. framework/v1-category - Create Category POST {{baseUrl}}framework/v1/category/create?framework={{frameworkId}}