FAQs

This page is used to address frequently asked questions about Framework service.

How to create a Framework?

A Channel/Tenant can have one or more frameworks.

Prerequisite: “Master Categories” should be created while doing service deployment. Master Categories are the list of categories from which a new framework’s category should be mapped to.

A Framework can have its categories corresponding to all master categories or its subset. Framework Categories are linked to Master categories by using the 'code' value same as that of master categories.

Below are the steps to create a new framework:

1. Create Framework

2. Create Framework categories

3. Create Terms for each category

4. Publish the Framework

Each term can be associated with another term from another category by using 'associationswith' attribute in Term update API

Example: { "request": { "term": { "associationswith": [ { "identifier": "associatetermidentifier1" //Term you want to add association with }, { "identifier": "associatetermidentifier2" //Term you want to add association with } ] } } }

'Level1-term', 'Level2-term' and 'Level3-term' can be created as treemap under the framework category. 'Level1-term’ is created as a term directly associated with framework category. However, 'Level2-term' and 'Level3-term' are created as terms using the Term create API with reference to parent using 'parents' attribute in Term create API.

Example: { "request": { "term": { "name": "Sample Term", "label": "Sample Term", "description": "Sample Term", "code": "sampleTerm" //needs to be unique within a framework "index": 20 //index of term display "parents": [ { "identifier": "parentIdentifier" //Term you want to add association to } ] } } }

API to create ‘Framework Master Category’:

curl --location --request POST '{{host}}/action/framework/v3/category/master/create'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{APIKey}}'
--header 'x-authenticated-user-token: {{user_token}}'
--data-raw '{"request":{"category":{"name":"Learning Outcome","description":"Learning Outcome","code":"learningOutcome","targetIdFieldName":"targetLearningOutcomeIds","searchLabelFieldName":"se_learningOutcomes","searchIdFieldName":"se_learningOutcomeIds","orgIdFieldName":"learningOutcomeIds"}}}'

Create Framework

Add Content to Framework

How to fetch list of all Frameworks in the sunbird instance?

Using Frameworks List API, we can fetch all the existing frameworks in the application