You can use the Catalog API to reference the unique item id of the specific item, which can be used to confirm exactly which version is showing on the catalog.
Due to the nature of this API, we reserve the right to modify it if needed in service of its primary function, driving the UI, with no notice provided.
To look up a specific item, from the catalog, you can use the following endpoint structure: /api/v1/catalog/{{itemtype}}/{{catalogid}}/{{pid}} where:
itemtyperefers to the type of form you are referencing, such as "course" or "program" in singular form.catalogidis the unique identifier for each catalog, which can be found by navigating to the catalog app and selecting a specific catalog. For example, the ID appears in the URL as follows:https://{{institution}}.kuali.co/catalog/#/catalogs/65e0fe81010f9e001cf2ba9a/generalPIDdenotes a unique ID for each item you wish to view, visible at the end of the URL when viewing an item in the catalog, like so:https://{{institution}}.kuali.co/catalog/student#/programs/B1Ao8pona
For example, the catalog may provide a URL like this: https://{{institution}}.kuali.co/catalog/student#/programs/B1Ao8pona?bc=true&bcCurrent=Anthropology&bcGroup=Anthropology&bcItemType=programs when looking up a program, but you can also reference it by just using https://{{institution}}.kuali.co/catalog/student#/programs/B1Ao8pona
The primary difference is how the breadcrumbs are provided on the page. If you just need to share an item quickly, you just need to make sure the item type and PID is included - a much shorter link!
Once you have looked up the item, the information will be formatted in JSON, and it'll look a bit like this:
Within the JSON, look for the API label "id": - this will contain the item's unique ID. It will be formatted like this: "id": "65de46a61c25438e4ef79939"
Now that you have the unique ID for the item, you can reference it within CM by appending it to the end of the URL for the matching item type.
For example, if you were to lookup a program, your URL would look like this: https://{{institution}}.kuali.co/cm/#/programs/view/65de46a61c25438e4ef79939
This will direct you to the exact version that is being shown on the catalog.
Comments
0 comments
Article is closed for comments.