Entity Widgets
Hierarchy JSON endpoints
| Style | Required | Optional | Working example (click to see the JSON) |
|---|---|---|---|
| Hierarchy list, found by name (one record) | catalogId in the path | page-size, page, legacy-id, type, name | /widget-api/catalog/41/hierarchies/?page-size=100&page=1&name=Accounting |
| Hierarchy detail (one record) | catalogId and internal entityId | None | /widget-api/catalog/41/hierarchy/1963/ |
See the full endpoint reference for the general list-then-detail pattern.
The documentation in the Publisher will list a section for creating Entity Widgets - this is referring to to the Hierarchy content within your catalog. The Widget can be used to pull the data through a Link, List, or directly on the page as Content - and does not need you to establish a filter within the catalog first.
Link Widget
This will generate a link to a single specific Hierarchy entity within a published, current catalog. (It can not be used to reference archived catalogs.) If you reference it by the entity's name, and the name doesn't change from year to year - then you won't have to update this link even when you publish a new catalog of the same type!
Example: Loading...
Tip:
The sandbox is going to generate a standard link URL, which will replace the current window, directing them away from this site and back to your catalog on Acalog. To return to this page, they would then need to use their browser back button. You can adjust the target of the URL by adding in the target="blank" HTML tag into your Widget code, to allow it to open in a new window/tab instead!
List Widget
Choosing to display all of the entities will place them in alphanumerical order based on their name - regardless of type or ownership. With entities, you won't have a lot of options for narrowing them down other than using the catalog filter to indicate which catalog you are pulling from - remember this is not the same as a filter within your catalog, so you won't have as many options. For that, you may want to go ahead and pull in a Filter Widget instead!
Entity List
This list of entities will open as links that direct the user away from this site and over to your catalog within Acalog.
- Loading...
Entity List - Dynamic
This list of entities uses the Dynamic option which allows the link to unfurl as a show/hide option, rather than directing the user away from the site.
- Loading...
Content Widget
This can be used to embed the contents of a hierarchy entity directly on your website without having directing your user to another site. Super helpful if you want to make sure your website and Acalog stay in sync without having to duplicate data entry. If you reference it by name, and the entity maintains that same name each year - then you won't have to update this reference even when you publish a new catalog of the same type!
In some of your entities, you're likely to have Permalink references - maybe to courses that are owned by the entity, for example. Depending on your preference, you can determine how those additional links should be have by using the Dynamic option to use a show/hide link to allow your users to determine if they want to review the full item, or if you want to direct them back to Acalog to review the additional information.