Change the title and URL of a course catalog

With the LMS365 API endpoints you can change the title and URL of the course catalog.

This function is helpful, for example, when you have created a course catalog with trainings on your test environment and now you are planning to move it to the production. In this case, you need to change the course catalog URL and probably you would like to change the course catalog title as well.

Change of the catalog title and URL involves two steps: rename of the existing catalog in SharePoint and rename of it in LMS365. This article describes these two steps.

In this article

 

Change of the catalog title in SharePoint

To change the title of the existing course catalog in SharePoint following the SharePoint Change a site address instructions.

 

Change of the catalog title and URL in LMS365

To change the course catalog title and URL using LMS365 APIs:

1. Go to https://api.365.systems/ and authorize with the relevant API key. You can find more about the authorization process in the Authorize with LMS365 API key in Swagger and Postman article.

2. In the CourseCatalogs section, find the GET method ​/odata/v2/CourseCatalogs with the Return the list of Course Catalogs description and then select Try it out in the top left corner. 

3. Select Execute and in the response body copy the ID of the course catalog that you want to change the title and URL of.

 

 

4. In the CourseCatalogs section, find the PATCH method ​/odata/v2/CourseCatalogs({Id}) with the Update individual fields of existing Course Catalog description and select Try it out in the top left corner.

5. Fill in the required fields:

  • The key:Id field  with the ID from step 2.
  • In the Edit Value field, replace string in the Title parameter with the new title for the catalog. If you want to change the URL of the catalog, replace string for the URL parameter with the new SharePoint URL. 
  • Delete Owners parameter from the body so that your catalog admins won't be deleted.

 

 

6. Select Execute to run the request.

After updating using API, the URL and the title of the catalog are changed immediately.

 

NOTE   

If synchronization fails, clean cache and cookies in the browser and reload the page.

 

Was this article helpful?
6 out of 9 found this helpful

Comments

Article is closed for comments.