PL/SQL API reference

Every page in this section is generated from the package specification in the source, so it is always in step with the installed code. This page groups them by purpose, because “which package do I need” is not answerable from an alphabetical list.

New to the APIs? Start with Managing the filesystem from the database, which walks through the common operations end to end, and The security model, which explains why your session needs a context before any of this works.

Start here

Package	For
`adm_context_api`	Establishing who your session is. Nothing else works without it.
`adm_access_control_api`	Asking whether a user may view or change something.
`adm_error`	Every error code, named exception and category.

Documents and folders

Package	For
`adm_document_api`	Create, version, rename, move, trash, restore, delete. Retention and legal hold. Comments.
`adm_folder_api`	The folder hierarchy: create, rename, move, trash, restore.
`adm_zip_api`	Pack a document or folder tree into a zip document; expand one back out.
`adm_aop_api`	Convert a document to PDF.

Package	For
`adm_user_api`	Create, activate and deactivate users.
`adm_group_api`	Groups and their membership.
`adm_shares_api`	Share documents and folders with users and groups; revoke.
`adm_link_shares_api`	Public link shares: publish a URL for one document, with a password and an expiry.
`adm_embed_api`	Embed tokens, for rendering ADM inside another application.
`adm_audit_api`	The audit log and its action types.

Search and metadata

Package	For
`adm_search_api`	Full-text and faceted document search.
`adm_tag_api`	Key/value tags on documents.
`adm_annotations_api`	Key/value annotations on documents and folders.
`adm_file_metadata_api`	Metadata extracted from the files themselves (`file.*`).
`adm_cache_api`	The cached shared-files list that user-scoped search reads.
`adm_mimetype_api`	Deriving a trustworthy mime type from content.

Storage

Package	For
`adm_storage_api`	Reading content, storage policies, migration between database and object storage.
`adm_storage_index_api`	The text-extraction queue behind content search.

Administration

Package	For
`adm_settings_api`	Reading and writing settings; object storage configuration and connectivity test.
`adm_job_automations_api`	The scheduled maintenance tasks.
`adm_hooks_api`	How registered hook PL/SQL is run, and the three events that trigger it.
`adm_utils`	Shared helpers — `escape_like` in particular, if you write your own path queries.

AI Pack

Installed separately — see AI Pack. Its packages have their own reference section.

Reading these pages

@private means private. Those signatures change between releases without notice. If a private procedure is the only way to do something you need, tell us instead of calling it.
No package commits. The transaction is yours, in every one of them.
Parameters default to the current context where a username is involved, so most calls take only an object id.
Ids are number and up to 32 decimal digits. Declare your variables number, never integer.

What is not here

Packages whose only caller is the product itself are withheld deliberately, because publishing a signature invites you to call something that is free to change in any release:

The file browser component’s server side — the region plug-in shell, its read and command sides, and its chunked upload. The <adm-file-browser> region is driven through its plug-in attributes, not through PL/SQL.
Plug-in callback interfaces — the APEX Office Edit save-to-table procedures. See Editing and converting documents for what you can configure.
Saved search configurations, written by the search page on the user’s behalf.
Helpers with no public surface — cryptography, e-mail, OCI object storage access and PDF region rendering.

They are marked @private at package level in their specs, which is what keeps them out of this reference. If you find yourself needing one of them, tell us rather than calling it: that is a gap in the public API and we would rather close it than have you depend on plumbing.