Search Categories
POST {{baseUrl}}/framework/v1/category/search?framework=Ut enim offici
This API is associated with searching a category
- The endpoint for Search Categories is /framework/v1/category/search
- It points to knowledge-mw-service - /v1/framework/category/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 category can be searched |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"id":"api.category.search","ver":"1.0","ts":"2020-12-14T19:40:23.864Z","params":{"resmsgid":"3558c380-3e44-11eb-9ff3-67c41480f6aa","msgid":"3555b640-3e44-11eb-9ff3-67c41480f6aa","status":"successful","err":null,"errmsg":null},"responseCode":"OK","result":{"count":2,"categories":[{"identifier":"dummy_framework_subject","lastStatusChangedOn":"2020-12-14T19:30:32.392+0000","code":"subject","frameworks":[{"identifier":"dummy_framework","name":"Framework Name","objectType":"Framework","relation":"hasSequenceMember","description":"Dumy framework updated","status":"Live"}],"consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","channel":"in.ekstep","description":"Updated description","domains":[],"createdOn":"2020-12-14T19:30:32.392+0000","versionKey":"1607974669043","terms":[],"appId":"dev.sunbird.portal","name":"Subject","lastUpdatedOn":"2020-12-14T19:37:49.043+0000","status":"Live"},{"identifier":"dummy_framework_medium","lastStatusChangedOn":"2020-12-14T19:32:01.700+0000","code":"medium","frameworks":[{"identifier":"dummy_framework","name":"Framework Name","objectType":"Framework","relation":"hasSequenceMember","description":"Dumy framework updated","status":"Live"}],"consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","channel":"in.ekstep","description":"Medium","domains":[],"createdOn":"2020-12-14T19:32:01.700+0000","versionKey":"1607974321700","terms":[],"appId":"@ignore@","name":"Medium","lastUpdatedOn":"2020-12-14T19:32:01.700+0000","status":"Live"}]}}