Usage Omeka S module

Browsing the API

Open API Browser from the admin sidebar, or go to /admin/api-browser.

The resource list

The sidebar lists every resource the API exposes, grouped by the module that provides it. Core resources such as items, media, item_sets, sites and users appear under Core; resources added by modules appear under the module's name. Resources from a newly installed module appear as soon as the module is active.

Each resource shows the operations available to you: List (search), Show (read one), Create, Update and Delete. Operations your role is not allowed to perform are not offered.

The overview

The Welcome entry under Overview at the top of the sidebar is the browser's start page. It explains that requests sent from the browser run as your logged-in user and lists every resource grouped by the module that provides it.

The API Browser's Welcome page: the sidebar with the credential selector, endpoint search and resources grouped under Backup, Blog and Core, and the list of resources by module
The API Browser start page

A resource's reference

Selecting a resource and an operation opens its reference, built from the running installation:

List items selected in the sidebar: the endpoint GET /api/items with its query parameter table in the middle, and the request console on the right with per_page, sort and search filled in
The reference and request console for List items
  • Endpoint: the collection path (/api/<resource>) or item path (/api/<resource>/{id}) and its HTTP method.
  • Query parameters (List): the parameters the search endpoint understands, such as page, per_page, sort_by, sort_order, property filters and search for full-text matching.
  • Body parameters (Create and Update): documented request fields, when the resource's module declares them.
  • Body: the JSON-LD keys you will find in responses, such as o:id, o:title, o:created and resource-specific keys, each with a type and description.
  • Responses: the status codes to expect, such as 200, 204 for delete, 403 and 404.

The sidebar search box matches resource names, JSON-LD keys and the underlying entity's field names, so you can find a resource by a column it stores.

For core resources the query parameters and JSON-LD keys come from a curated catalog. Modules can supply their own; see Extending the Browser.

OpenAPI links

The OpenAPI (JSON) and OpenAPI (YAML) buttons in the page actions download the full specification. See OpenAPI Export.

Log in for Support