Read ObjectCategoryDefinition
GET {{baseUrl}}/object/category/definition/v1/read/{{objectCategoryId}}?fields=sit
This API is associated with viewing and reading out the master object category on the Sunbird Platform .
- The /read/{objectCategoryDefinitionId}_ endpoint executes request for fetching the contents to be viewed and read.
- The endpoint for Update Object Category Definition is /object/category/definition/v1/read/{ID}
- It points to taxonomy-service - /object/category/definition/v4/read/{ID}
- {...}refers to a section of reject endpoint URL path that needs to be replaced by appropriate Id.
- You need to provide a valid object category definition Id value in {objectCategoryDefinition_Id} field of API URL.
- It is mandatory to provide values for parameters marked with *.
- Mandatory fields cannot be null or empty.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"id":"api.object.category.definition.read","ver":"3.0","ts":"2020-12-17T13:25:16ZZ","params":{"resmsgid":"e61aee2f-8099-4978-a624-6605360218e1","msgid":null,"err":null,"status":"successful","errmsg":null},"responseCode":"OK","result":{"objectCategoryDefinition":{"identifier":"obj-cat:checking-account","lastStatusChangedOn":"2020-12-17T09:09:55.687+0000","consumerId":"7411b6bd-89f3-40ec-98d1-229dc64ce77d","name":"Checking Account","channel":"in.ekstep","lastUpdatedOn":"2020-12-17T11:15:37.740+0000","description":"Textbook Unit","createdOn":"2020-12-17T09:09:55.687+0000","objectType":"ObjectCategory","versionKey":"1608203737740","status":"Live","objectMetadata":{"config":{},"schema":{}},"languageCode":[],"forms":{}}}}