Get Glossary of the API

Returns the Glossary of the API: the union of

• static Glossary Items, compiled into the API and only changing when the API is redeployed, and
• Dynamic Glossary Items, held in the database and maintained with POST, PUT and DELETE on this same path.

A Dynamic Item replaces a static one of the same title. Each entry reports which it is:

• is_dynamic — true when the entry comes from the database rather than the API source.
• overrides_static_item — true when this Dynamic Item is displacing a static Item of the same title. Overriding has to be declared when the Item is created, so this is deliberate; the API also reports these in its logs at startup.
• glossary_item_id, created_at and updated_at are present for a Dynamic Item and absent for a static one, which has nothing to manage. created_by_user_id is returned to authenticated callers only.

One Item at a time. GET /obp/v7.0.0/api/glossary/TITLE returns a single Item. Prefer it — the whole Glossary is around a megabyte, which is a lot to download to read one entry.

Optional query parameters:

• search — only Items that contain what you type, case insensitively, looking at the title and at the text of the Item. The words are matched one by one and an Item has to contain all of them, so search=agent messages finds the Item titled Signal Channels even though neither word is in its title. Items whose titles contain every word are listed before those that only match on their text.
• source — all (default), static or dynamic.
• limit and offset — page the result. Without limit the whole Glossary is returned, as it always has been. total_count counts what matched before paging.

This is the same Glossary that GET /obp/v3.0.0/api/glossary returns. That version is STABLE and its JSON cannot change, so it carries neither the fields above nor these parameters.

User Authentication is Optional. The User need not be logged in.