Advanced Search Reference 📰

Create expansive search criteria, and save the searches for repetitive use. Saved searches expand beyond our filters and descriptive metadata to locate your media.

Contents


How to Use an Advanced Search Query


Search Syntax

Text Searching:

title:example
title:"Here is an example with spaces"

Where

The left-hand side of the colon (:) is the field within Imagen to be searched

The right-hand side of the colon (:) is the term to be searched for


Date Ranges:

dateTime:[2021-01-01 TO 2021-02-01]

Between two dates

dateTime:[2021-01-01 TO *]

After a given date

dateTime:[* TO 2021-01-01]

Before a given date


Imagen Syntax Examples:

Record Number

This could return a single record but could contain a range of or list of IDs

"recordID":[Record ID goes here]

Description

This is a standard text search, looking for matches where a certain term has been matched

"Description": "[Description goes here]",

Record ACL

This could be useful when looking for records to which a certain user/group of users have access

User ID(s) below

"writeAccess": [User ID(s) go here],

"readAccess":[User ID(s) go here],

"mediaDownloadAccess":"[User ID(s) go here]"

💡Pro Tip: follow this guide on user management to find your user ID(s)


Record Creation Date and Time

The DateTime of when your record was created. This could be a date range.

"Creation_Date_and_Time": "[2021-01-01T00:01:00Z TO 2021-02-01T00:02:00Z]"

Media Extension

The media extension of any media attached to your records. You may get many results. 

"mediaElementExtension":"[jpg mp4 mov etc.]"

Media Archived Time

The datetime of when your media was successfully stored. This will not include failed media.

"mediaArchivedTime":"[2021-01-01 TO 2021-02-01]"

Media Object Number

The Integer ID of your media object

"mediaObject":[Media Object ID goes here]

Original File Name

This is normally the location from which the media was ingested.  

"mediaOriginalFileName":"[https://some_server.com/media/example.jpg]"

💡Pro tip: This could be used to return all records where some media has been ingested from a specific location. To do this simply strip out the '/'s, for example:

"mediaOriginalFileName":"[https://some_server.com/*]"


Media Type

This will return all records that contain a specific media type

"mediaType":"[Image][Video][Document"

Media Object State

This will return any records with at least one piece of archived or failed media. This can be used to quickly return all records that have failed media

"mediaObjectState":"[archived][failed]"

Annotations

This will return all records where annotations are present

annotations:[* TO *]

This will return all records where annotations are NOT present

-annotations:[* TO *]

The difference here is the '-' at the beginning of the query. This reverses the query to a negative match

💡Pro Tip: Search queries can be combined by using the AND, OR, NOT, operators

Follow this link for more information on the solar query parser: Solr query parser