Data Dictionary (Glossary)
Introduction
Data dictionary previously known as Glossary contains the term that we use for objects and users (both suggested by ScopeMaster and those confirmed by you). A glossary associated with one and only one app.
Available Commands
List Data Dictionary Items
Fetch the glossary items, with the context of a given app (set of requirements)
GET /apps/{app_id}/glossary
Get a Data Dicitonary Item
Fetch a single glossary item. Note that the name attribute is a lowercase, trimmed version of the original_name.
GET /glossary/{glossary_id}
{ "id":"GL8fefb6ec86", "name":"profile", "original_name":"Profile", "app_id":"AP488280a714", "type_of":"OBJECT", "definition":"", "created_utc":"1613906507", "updated_utc":"1613906508" }
Add Dictionary Item
Add/confirm a glossary word or phrase in the context of an App. This is the equivalent of confirming an item within the ScopeMaster UI.
POST /apps/glossary
Body must contain app_id, name and type_of USER or OBJECT. For example
{"app_id":"AP12345eF", "name":"visitor", "type_of":"USER"}
Update Dictionary Item
PUT /glossary/{glossary_id}
Updates the glossary name, if a matching one exists. Example PUT body:
{"name":"Profile"}
returns the updated glossary item:
{"seconds":0.0514, "message":"updated", "glossary":{ "id":"GL8fefb6ec86", "name":"user_profile", "original_name":"User_Profile", "app_id":"AP488280a714", "type_of":"OBJECT", "definition":"", "created_utc":"1613906507", "updated_utc":"1613906508"} }
Delete Glossary Item
DELETE /glossary/{glossary_id}
Deletes the glossary item, if it exists.
returns 200, no json body.