AJAX Metadata API

The server-side AJAX APIs provides methods to retrieve, create, update, and delete the following Platform metadata elements:

Application
Object
Field
Relationship

Note: All metadata methods require administrative privileges, regardless of the view, edit, create and delete permissions set on the application or object. Establish the session to use these methods by logging in with credentials for an administrative user.

To use the metadata API you must reference metadata.js on your web page. Use the Page Editor and add the following HTML code-snippet to your Script component:

<script src='../js/metadata.js' type='text/javascript' charset='utf-8'></script>

Note: This code-snippet is available through the Helper user interface.

For more information about XML metadata definitions for Platform applications, see Metadata XML reference.

Note: The metadata related APIs are supported in portals.