Magic of Metadata API and Functions Overview
Explore the magic of Metadata API and its functions, including basic and advanced operations, linking examples, and custom gadget use cases. Learn how to create, update, delete, and list metadata entries, as well as linking metadata with CMS data models.
Download Presentation
Please find below an Image/Link to download the presentation.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author. If you encounter any issues during the download, it is possible that the publisher has removed the file from their server.
You are allowed to download the files provided on this website for personal or commercial use, subject to the condition that they are used lawfully. All files are the property of their respective owners.
The content on the website is provided AS IS for your information and personal use only. It may not be sold, licensed, or shared on other websites without obtaining consent from the author.
E N D
Presentation Transcript
2 The Magic of Metadata API Cory Madden, Associate Product Manager
Agenda What is the metadata API? Methods of metadata Where can it be used? Further documentation 3
What is the Metadata API? Document-based database Creates persistent data Uses JSON to store the data Free-form content structure YOU create schema with identifier YOU consume the schema Can be any JSON structure Can be anything YOU consider is important! 4
Basic Functions of Metadata Has the standard CRUD operations List View Create Update Delete Has some Update/Delete operations for multiple metadata entries Update Delete 5
Metadata API Call Example /metadata/new endpoint via gadgetlib.js 6
Advanced Functions of Metadata Linking creates a relationship between metadata and a CMS data model. Linking should be always be called after the ID is returned from a /new call, or else the metadata will be "orphaned", and only visible via mime type lookups (List/View calls without the item parameter). Asset Asset Page Page Directory/Folder Directory/Folder Site Site Group Group Unlinking As you may have guessed, removes this relationship. 7
Linking Example Link your metadata with a link_type 8
Where can it be used? Primary use is for your custom gadgets! Can share data between multiple gadgets Two Omni CMS system gadgets use the metadata API 9
Bookmark Gadget Allows users to bookmark specific product locations for fast access. The JSON schema is grouped by folder by front end display. Utilizes the basic functions (CRUD) of metadata API 10
Notes Gadget Allows a user to write a note about a given file or asset. Can be a public or private note Utilizes the linking function of the metadata API 11
Further Documentation https://developers.omniupdate.com Sidebar Link to Metadata https://github.com/omniupdate/gadget-starter Contains methods that will make your custom gadget easier to make! 12
Thank you! 13
