Create Glossary Item
POST /obp/v7.0.0/api/glossary
OBPv7.0.0-createGlossaryItem Roles: CanCreateGlossaryItem Documentation
Adds an Item to the Glossary. The Item is stored in the database — a Dynamic Glossary Item — and served by GET /obp/v7.0.0/api/glossary alongside the Items compiled into the API.
description is markdown, the same flavour the static Glossary uses. It is returned as both markdown and rendered html.
Titles are unique case insensitively — creating one that already exists returns 409; update it with PUT /obp/v7.0.0/api/glossary/TITLE instead.
Overriding a static Glossary Item. If the title matches one of the API's own (static) Items, the request is refused with OBP-30577 unless you set overrides_static_item: true. That way an Item never displaces shipped documentation just because its title happened to be taken. When you do declare it, this Item replaces the static one everywhere the Glossary is served — including the Glossary text embedded in endpoint descriptions — and deleting it restores the static text.
The response reports both overrides_static_item (what you declared) and shadows_static_glossary_item (whether a static Item of this title exists right now). They differ if a static Item is added later with a title this one already used; that case is reported in the API logs at startup.
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON request body fields (3)
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- title
- Dr.
- overrides_static_item
- overrides_static_item
JSON response body fields (11)
- description
- Description of the object. Maximum length is 2000. It can be any characters here.
- html
- html format content
- is_dynamic
- is_dynamic
- markdown
- overrides_static_item
- overrides_static_item
- shadows_static_glossary_item
- shadows_static_glossary_item
- title
- Dr.
- created_at
- created_at
- created_by_user_id
- glossary_item_id
- glossary_item_id
- updated_at
- updated_at
Example request body
{
"title": "Bank.bank_id",
"description": "The unique identifier of the Bank on this OBP instance.\n\nExample value: gh.29.uk",
"overrides_static_item": true
}Example success response
{
"glossary_item_id": "8f2b1c44-1f2a-4c3d-9a7e-5b6c7d8e9f01",
"title": "Bank.bank_id",
"description": {
"markdown": "The unique identifier of the Bank on this OBP instance.",
"html": "<p>The unique identifier of the Bank on this OBP instance.</p>"
},
"is_dynamic": true,
"overrides_static_item": true,
"shadows_static_glossary_item": true,
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_at": "2026-10-21T01:45:41Z",
"updated_at": "2026-10-21T01:45:41Z"
}Possible errors (7)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-10001: Incorrect json format.
- OBP-30573: Invalid Glossary Item title. It must be non empty and at most 255 characters.
- OBP-30572: Glossary Item already exists. Please specify a different value for title, or update the existing one.
- OBP-30574: Could not create Glossary Item.
- OBP-50000: Unknown Error.