Update Collection Hierarchy
PATCH {{baseUrl}}/collection/v1/hierarchy/update
This API is associated with updating collectio on the Sunbird Platform .
- /Update/ endpoint executes the Update Collection Hierarchy
request based on parameters provided as metadata in the request body.
- The endpoint for Update Collection Hierarchy is /collection/v1/hierarchy/update
- It points to knowledge-mw-service - /v1/collection/hierarchy/update
- {...}refers to a section of review endpoint URL path that needs to be replaced by appropriate Id.
- It is mandatory to provide values for parameters marked with *.
- Mandatory fields cannot be null or empty.
Request Body
{"request"=>{"data"=>{"nodesModified"=>{"do_113444715309432832183"=>{"root"=>true, "objectType"=>"Content", "metadata"=>{"appIcon"=>"", "name"=>"Untitled Collection", "description"=>"Enter description for Collection", "dialcodeRequired"=>false, "primaryCategory"=>"Content Playlist", "audience"=>["Student"], "mediumIds"=>["ekstep_ncert_k-12_medium_english"], "gradeLevelIds"=>["ekstep_ncert_k-12_gradelevel_class1"], "subjectIds"=>["ekstep_ncert_k-12_subject_mathematics"], "author"=>"N11", "copyright"=>"NIT123", "license"=>"CC BY 4.0", "contentType"=>"Collection", "keywords"=>["nnn"], "boardIds"=>["ekstep_ncert_k-12_board_cbse"], "copyrightYear"=>2121}, "isNew"=>false}}, "hierarchy"=>{"do_113444715309432832183"=>{"name"=>"Untitled Collection", "root"=>true}}, "lastUpdatedBy"=>"5a587cc1-e018-4859-a0a8-e842650b9d64"}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | (Required) The Content Type entity is the media type of the resource.Possible media types can be:- |
- Application/json |
|
X-Authenticated-User-Token| string | | (Required) The Registered User ID used to execute the API. | |X-Channel-id| string | | The unique ID provided to the State to which the user belongs. | |Authorization| string | | (Required) All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API. | |Accept| string | | |
RESPONSES
status: OK
{"id":"api.hierarchy.update","ver":"1.0","ts":"2022-01-03T09:43:27.001Z","params":{"resmsgid":"99def090-6c79-11ec-b3c3-d9afeab1a49c","msgid":"fec10a19-18ca-743d-2594-701f84f47462","status":"successful"},"responseCode":"OK","result":{"content_id":"do_113444715309432832183","identifiers":{}}}