Interfaces
imeji supports following data interfaces:
RESTful interface to use imeji in different ways (since imeji 3.0.0.0) Documentation: in github wiki Examples: Swagger demonstrator
RDF export interface for the imeji application. Parameter: format, type, q, n
- format: rdf, sitemap
- type: Type of item (image, collection, album, mdprofile)
- q: The query
- n: The offset
Example: http://demo.imeji.org/imeji/export?format=rdf&type=image&n=10000&col=14
imeji allows the fetching of metadata from its repository by supporting the Open Archives Initiatives Protocol for Metadata Harvesting (OAI-PMH). The mapping of the native imeji rdf to oai_dc is provided below:
| oai_dc | imeji rdf | Comment |
|---|---|---|
| record | -- | wrapper |
| record:header | -- | wrapper |
| record:header:identifier | RDF:image@rdf:about | |
| record:header:setSpec | RDF:image:collection@rdf:resource | |
| record:metadata | -- | wrapper |
| record:metadata:dc | -- | wrapper |
| record:metadata:dc:creator | RDF:image:properties:createdBy@rdf:resource | |
| record:metadata:dc:description | RDF:image:metadataSet:metadata:imeji-metadata:ns:imeji-metadata:text if imeji-metadata:ns contains 'description' | |
| record:metadata:dc:date | RDF:image:properties:creationDate | |
| record:metadata:dc:type | RDF:image: | |
| record:metadata:dc:identifier | -- | album |
| record:metadata:dc:rights | RDF:image:metadataSet:metadata:imeji-metadata:license | |
| record:metadata:dc:coverage | RDF:image:metadataSet:metadata:imeji-metadata:name | |
| record:metadata:dc:source | RDF:image@rdf:about |
Gives back information on the imeji Repository.
- Parameter: None
- Example: http://demo.imeji.org/fledgeddata/oai/?verb=Identify
- Not supported: None
Gives back all metadata formats which are supported by the repository. All listed formats can be used as a parameter for a GetRecord request (currently collections and albums can only be fetched in native imeji format).
- Parameter: None
- Example: http://demo.imeji.org/fledgeddata/oai/?verb=ListMetadataFormats
- Not supported: identifier
Gives back a list of sets which are provided by the repository. imeji provides by default, all collections and albums as sets.
- Parameter: None
- Example:
- Not supported: resumptionToken
Gives back a specific record, specified in the identifier parameter. A record can be everything with a url in imeji, currently: images, collections and albums.
- Parameter: identifier, metadataPrefix
- Example: http://demo.imeji.org/fledgeddata/oai/?verb=GetRecord&identifier=http://demo.imeji.org/item/gOjdOLDeEqXJbkvj&metadataPrefix=imeji
- Not supported: Handling of deleted records
Gives back the oai header for all images in the repository or, if set parameter is defined, all images of a set.
- Parameter: metadataPrefix, set
- Example: http://demo.imeji.org/fledgeddata/oai/?verb=ListIdentifiers
- Not supported: from, until, resumptionToken
Gives back the metadata record of all images in the repository or, if set parameter is defined, all images of a set.
- Parameter: metadataPrefix, set
- Example: http://demo.imeji.org/fledgeddata/oai/?verb=ListRecords&metadataPrefix=imeji
- Not supported: from, until, resumptionToken
The sitemap functionality of the Fledged Data Service exploits the oai interface and creates a sitemap out of all items it retrieves with a ListIdentifiers call. Therefore only image URLs will be listed in the sitemap.xml. The interval of the sitemap creation can be configured in the fds properties file.