[4.10] User Update API Rejects Newly Added Framework Terms

[komalm]

Hello @AmiableAnil @Hari-stackroute ,

Environment Details:

Platform: SunbirdEd Portal

Version: 4.10

Background:
We are encountering an issue with saving newly added (framework) terms to the User Preferences. Although the new terms are created, associated, and visible in the UI (e.g., in the Grade Level dropdown), users are unable to save these new selections — the User Update API fails during the process.

Steps to Reproduce / Setup for New Terms:

1. Create new terms using the term creation API:

curl --location '{{host}}/api/framework/v1/term/create?framework={{frameworkName}}&category=gradeLevel' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
    "request": {
        "term": {
           "name": "Test",
           "label": "Test",
           "description": "Test",
           "code": "test"
        }
    }
}'

2. Associate the new terms (e.g., Grade Level) with an existing board using the Term Association API:

curl --location --request PATCH '{{host}}/api/framework/v1/term/update/test?framework={{frameworkName}}&category=gradeLevel' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "request": {
        "term": {
            "associationswith": [
                {
                    "identifier": "{{frameworkName}}_board_urbanplanningandhousing"
                }
            ]
        }
    }
}'

3. Publish the updated framework: its

curl --location --request POST '{{host}}/api/framework/v1/publish/{{frameworkName}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}} ' \
--header 'X-Channel-Id: 0130701891041689600'

response is

"publishStatus": "Publish Operation for Framework Id 'frameworkName' Started Successfully!"

4. The new term appears correctly in the UI dropdown under User Preferences.

Issue:
When a user selects the newly added term and clicks “Save,” the User Update API fails with an error.

curl --location --request PATCH '{{host}}/learner/user/v3/update' \
--header 'Accept: */*' \
--header 'Accept-Language: en-US,en;q=0.9' \
--header 'Connection: keep-alive' \
--header 'Content-Type: application/json' \
--data '{
    "params": {},
    "request": {
        "framework": {
            "board": [
                "Urban Planning and Housing"
            ],
            "medium": [
                "Hindi",
                "Marathi",
                "English"
            ],
            "gradeLevel": [
                "test"
            ],
            "id": "nulp-domain"
        },
        "userId": "c2e51579-e603-4ba5-97c8-7fbdba02394f"
    }
}'

Response

{
    "id": "api.user.update",
    "ver": "v3",
    "ts": "2025-05-23 06:57:05:596+0000",
    "params": {
        "resmsgid": "85effd1c1c073281f6b90049aea912f2",
        "msgid": "85effd1c1c073281f6b90049aea912f2",
        "err": "UOS_USRUPD0017",
        "status": "FAILED",
        "errmsg": "Invalid value test for parameter framework.gradeLevel. Please provide a valid value."
    },
    "responseCode": "CLIENT_ERROR",
    "result": {}
}

Note:

1. This issue occurs only with newly added terms.
2. The same API works fine for existing terms in the framework.

Request for Support:
Could you please guide us on the necessary steps to solve this issue.
We would appreciate your support in resolving this issue.

cc @vinod303, @siddhishinde0723

[komalm]

Hello Team,

Could you please guide us on the necessary steps to solve this issue.
We would appreciate your support in resolving this issue.

[amol-chitale]

@rhwarrier - Can you please help here with the resolution?

[aimansharief]

Hey @komalm , could you please try the framework read API and check if these terms are present? If not, try restarting the content service and then check again. If the issue persists, we can connect and look into it together.

[Raghavms03]

I have tested the same on both prod and dev. And we have restarted the content services on dev, still we are facing the update API issue. We couldnt find Framework read API.

[aimansharief]

Hey @Raghavms03, could you please refer to the read API provided in this link and carry out the activity I mentioned above?
https://knowlg.sunbird.org/learn/product-and-developer-guide/taxonomy-and-tagging/framework-service/apis

[komalm]

(Cause Not Definitively Identified)

Summary of Resolution:
While working on scaling down the VMs, the issue was observed to be resolved. Though the root cause could not be pinpointed with certainty, the following actions were performed which might have contributed to the resolution:

1. Restarted the Content Service
2. Restarted the Lern Service
3. Restarted the Learning Tomcat Server