A series of configured endpoint shortcuts are available. A common feature of these shortcuts is that they allow you to retrieve an object by its name (case insensitive) rather than its UUID.
Shortcuts: coll, collection, collections
# look up collection by name
eq coll --name 'Syllabus Collection'To query EQUELLA collection info, by default you need to pass a "privilege" (EQUELLA permission) that the API account will have with the --privilege flag or in the URL path. eq defaults to VIEW_ITEM if you don't provide a privilege.
Shortcuts: group, groups
# look up group by name
eq group --name 'Photography Faculty'Shortcuts: item
# query item XML metadata using xpath with -x or --xp flags
eq item '1234-abcd-1234-ab12cd34' --xp '//mods/titleInfo/title/text()'
# using --text will automatically append '/text()' onto the xpath
eq item '1234-abcd-1234-ab12cd34' -x '//mods/titleInfo/title' --textShortcuts: role, roles
# look up role by (case sensitive) name
eq role --name 'Student Contributor Role'Shortcuts: s, search
# XML query, note comparison must be wrapped in single quotes
eq search --where "/mods/name/namePart LIKE 'Mike*'"
# complex query, *all* the parameters
eq search --query 'free text query' --order modified --start 10 --length 30 --collections 6b755832-4070-73d2-77b3-3febcc1f5fad --showall --info metadata
# same query as above but using all shorthand flags
eq s -q 'free text query' -o mod --start 10 -l 30 -c 6b755832-4070-73d2-77b3-3febcc1f5fad --all -i mdThere are many search filters that can be applied; it's best to review openEQUELLA's API docs to fully understand your options. This endpoint supports the following parameters (with their shortcuts in parenthesis):
- query (q): free text query
- start: item to start on (for paging through multiple results lists)
- length (l): number of items to return (max 50)
- collections (coll, c): comma-separated list of collection UUIDs to search
- order (o): what metadata to sort the results by. The options are name, date modified (modified), rating, & relevance.
- where (w): XPath-like "where" clause e.g.
--where="/metadata/title LIKE 'HELLO WORLD*'" - info (i): what data to include in the results. The options are all, attachment, basic, detail, drm, metadata, & navigation. Note that results do not include their XML metadata unless you ask for it in the "info" parameter.
- modifiedAfter (ma) & modifiedBefore (mb): narrow by date modified, these are
YYYY-MM-DDdates - owner: the user that owns the item. Only accepts one username (for external users) or UUID (for local/internal ones).
- showall (all, show): boolean flag that defaults to
false, include items that are not yet live, e.g. draft, archive, suspended, etc. statuses - status (s): include items with only these statuses. The options are archived, deleted, draft, live, moderating, personal, rejected, review, and suspended. The presence of this option will override
showallsince the two conflict. - reverse (r): boolean flag that defaults to
false, reverse the order of the results
The order and info parameters are validated against their possible options and have various shortcuts for common values, e.g. --info=xml for metadata.
Shortcuts: s2, search2
# limit results to collections within a specific advanced search
eq s2 -q 'free text query' --advancedSearch 6b755832-4070-73d2-77b3-3febcc1f5fad
# find items with a specific MIME type
eq s2 --mimeTypes 'image/jpeg,image/png,image/gif'
# find items with generated thumbnails
eq s2 --musts 'realthumb:true' && eq s2 --musts 'videothumb:true'
# export 1st 10 results to CSV (must be limited to a single collection, can be very slow)
eq s2 --export --collections 6b755832-4070-73d2-77b3-3febcc1f5fad -l 10 > results.csvThe search2 endpoint has the same parameters as search above but with the addition of a few new ones. It was designed to meet the needs of the new UI so there is a particular focus on attachments and thumbnails because its data is meant to be rendered into gallery-like views. The CSV export, in particular, is a powerful and unique feature but in practice it can be very slow to download data from collections with expansive metadata schemas (like MODS) or many repeated fields (e.g. many subjects or attachments). The new features from search2 are:
- searchAttachments: boolean to search attachment contents such as text files (defaults to true)
- includeAttachments: boolean to include full attachments details in the response, which can slow down response times (defaults to true)
- advancedSearch: provide the UUID of an advanced search & results will be limited to the collections specified in that search
- mimeTypes (mt): comma-separated list of MIME types to filter results by
- musts: comma-separated list of "search index key/value pairs", the examples they give are "videothumb:true" & "realthumb:true"
- export (e): export results, writes a CSV to stdout. Only works if the search is limited to a single collection (see the -c flag)
Shortcuts: tax, taxo, taxonomy
# print all taxonomies (unless you have more than 5k!)
eq tax --length 5000
# look up taxonomy by name instead of UUID
eq tax --name 'Semesters'
# get all the top-level terms
eq tax --name 'Semesters' --terms
# look up a term or branch of terms within a taxonomy
eq tax --name 'Semesters' --term 'Spring 2015'I haven't found success looking up a term multiple layers deep into a taxonomy hierarchy, e.g. "Spring\2015" but perhaps it's because I'm not escaping the slash properly.
Searching taxonomy terms is also supported, with options for all the search API settings. By default, the taxonomy term search looks in the full term, isn't restricted to top-level or leaf terms, and uses the default limit of 20 search results.
# search leaf (bottom of hierarchy) terms only
eq tax --name 'semesters' -s 'Spring 2014' --leaf
# search top-level terms only & get more results
eq tax --name 'semesters' -s 'Spring 2014' --top --limit 50
# don't search the full term path
eq tax --name 'semesters' -s 'Fall 2013' --fullterm=falseShortcuts: user, users
# look up user by (case sensitive) name
eq user --name 'phette23' # -q also works