CLARIN Metadata Repository

This is a draft description of the REST-interface of CLARIN Metadata Repository. Especially the response description is very sketchy yet.

Resources

Collections summary

/?operation&collection&maxdepth

This interface provides summary of the basic collections hierarchy in which the MdRecords are organised

Methods

GET

request query parameters

parameter value description

parameter	value	description
operation	string Fixed: `getCollections`
collection	URI Default: `root`	handles identifying the examined collection
maxdepth	integer Default: `1`	how deep in the collection hierarchy tree to go

operation

string

Fixed: getCollections

collection

URI

Default: root

handles identifying the examined collection

maxdepth

integer

Default: 1

how deep in the collection hierarchy tree to go

available response representations:

text/xml (mds:Collections)

Model summary

/?operation&q&collection&maxdepth

This interface provides summary of the xml structures used in the MdRecords

Methods

GET

request query parameters

parameter	value	description
operation	string Fixed: `queryModel`
q	XPath	just default simple paths: Components/olac
collection	URI Default: `root`	handles identifying the collection
maxdepth	integer Default: `1`

available response representations:

text/xml (mds:Terms)

Search interface

/?operation&query&collection&startRecord&maximumRecords

This interface provides actual search-functionality. The query-format is XPath, the result is based on SRU/CQL standard (searchRetrieveResponse), individual records are full MDRecords (root elem: CMD).

Methods

GET

request query parameters

parameter	value	description
operation	string Fixed: `searchRetrieve`
query	XPath
collection	URI Default: `root`
startRecord	integer Default: `1`
maximumRecords	integer Default: `50`

available response representations:

text/xml (mds:searchRetrieveResponse)

Representations

text/xml (mds:Collections)

XML Schema

Source:

plain parameters

parameter	value	description
collection_name	QName (repeating)	XPath to value: `//Collection` Link:

text/xml (mds:Terms)

XML Schema

Source:

plain parameters

parameter	value	description
cmdIndex	anyURI (repeating)	XPath to value: `//mds:Terms/@path`

text/xml (mds:searchRetrieveResponse)

XML Schema

Source:

plain parameters

parameter	value	description
records	anyURI	XPath to value: `//records/record/CMD`