Search Term
POST {{baseUrl}}/framework/v1/term/search?framework=Ut enim offici&category=Ut enim offici
This API is associated with searching the existing terms under a category in a framework on Sunbird Platform
- The endpoint for Search Term is /framework/v1/term/search
- It points to knowledge-mw-service - /v1/framework/term/search
- The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
framework | string | (Required) Represents the framework in which the term is to be searched | |
category | string | (Required) Represents the category in which the term is to be searched |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"api.term.search","ver":"1.0","ts":"2020-12-17T08:12:44.816Z","params":{"resmsgid":"a446e900-403f-11eb-9b0c-abcfbdf41bc3","msgid":"a4447800-403f-11eb-9b0c-abcfbdf41bc3","status":"successful","err":null,"errmsg":null},"responseCode":"OK","result":{"terms":[{"associations":[],"identifier":"dummy_framework_subject_english","lastStatusChangedOn":"2020-12-14T19:44:02.260+0000","code":"english","consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","channel":"in.ekstep","description":"English","createdOn":"2020-12-14T19:44:02.260+0000","versionKey":"1607975299669","children":[],"appId":"dev.sunbird.portal","name":"English","lastUpdatedOn":"2020-12-14T19:48:19.669+0000","categories":[{"identifier":"dummy_framework_subject","name":"Subject","objectType":"CategoryInstance","relation":"hasSequenceMember","description":"Updated description","status":"Live"}],"category":"subject","status":"Live"}],"count":1}}