Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added valid element names in for search conditions

...

Name

Type

 

Used in condition

Currently implemented

condition

string

A condition consists of a metadata element name followed directly by an operator, followed directly by a value. 

Valid element names are (TBD) : fedora_id, modified, created, content_size, mime_type, rdf_type

Valid operators are:  =, >, <, =>, <=

A search URI may specify one or more conditions

N

(tick)

fields

string

A comma separated list of fields to be returned in the search results

N

(tick)

max_results

int

Maximum number of results to return in a single “page”

N

(tick)

offset

int

The offset of the first result in the page.  The field is used in conjunction with max_results in order to present paged results.

N

(tick)

order_by

string

Field name to order the query by 

N

(tick)

order

string

asc or desc

N

(tick)

format

string

The format of the results. Valid values are: 

  • json
  • text
  • csv

N


modified

date string : Rfc 8601

The modification date: eg 2020-05-01T20:05:14+00:00

Y

(tick)

created

date string : Rfc 8601

The creation date: eg 2020-05-01T20:05:14+00:00

Y

(tick)

sha1

string

The SHA-1 of the resource

Y


md5

string

The MD5 of the resource

Y


rdf_type

string (URI)

The URI or abbreviated string representing the RDF type. Here are some examples: 

http://www.w3.org/ns/ldp#NonRDFSource

ldp:NonRDFSource

http://www.w3.org/ns/ldp#RDFSource

ldp:RDFSource

Y

(tick)

mime_type

string

The mimetype

Y

(tick)

fedora_id

string (URI)

The fedora resource ID*.  Given the resource http://localhost:8080/rest/resource1 ,  you may format this condition in the following three ways: 

fedora_id= resource1

fedora_id= /resource1

fedora_id= info:fedora/resource1

fedora_id= http://localhost:8080/rest/resource1

Y

(tick)

ocfl_id

string

The OCFL Object ID* 

Y

(tick)

content_size

int

The size of a resource in bytes

Y

(tick)

ancestor

URI

URI of the ancestral resource 

Y


ancestors

boolean

Used in conjunction with the fedora_id field. When set to true, display the ancestors.

N


depthintIndicates the depth of recursive descendents query queries.  1 would indicate just the immediate  children, 2 grandchildren, 3 great-grandchildren, and so on.N

descendants

boolean

Used in conjunction with the fedora_id field. When set to true, display the descendants.

Y


...