Max Planck Institute for the History of Science - CMS Services
- Url: /mpiwg-mpdl-cms-web/doc/GetDocument
- Request parameters
- id (required)
- identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")
- Response output
- Url: /mpiwg-mpdl-cms-web/doc/DocumentOperation
- Request parameters
- srcUrl (optional)
- url of the source document (if operation is create)
- docId (required)
- document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")
- elementNames (optional)
- list of xml element names which should be indexed
- default: "s head caption variables description"
- operation (required)
- create (if docId already exists then it is updated)
- delete
- outputFormat (optional)
- xml
- html
- string
- default: xml
- Response output
- Url: /mpiwg-mpdl-cms-web/query/GetPage
- Request parameters
- docId (required)
- document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")
- page (optional)
- page number in document
- default: 1
- normalization (optional)
- orig (original)
- reg (regularized)
- norm (regularized and normalized)
- default: norm
- highlightQuery (optional)
- Lucene query string for which words should be highlighted
- default: empty
- highlightQueryType (optional)
- form (form)
- morph (morphological)
- default: form
- highlightElem (optional)
- element name which should be highlighted
- default: empty
- highlightElemPos (optional)
- element position which should be highlighted
- default: 1
- mode (optional)
- untokenized
- tokenized (page result is enriched with word elements: e.g. <w lang="deu" form="satz" formRegularized="satz" formNormalized="satz" forms="satz, sätze, satzes" lemmas="satz">Satz</w>)
- default: untokenized
- outputFormat (optional)
- html
- xml (pure xml)
- xmlDisplay (xml like display through html)
- default: html
- cssUrl (optional)
- Response output
- Url: /mpiwg-mpdl-cms-web/query/QueryDocuments
- Request parameters
- query (required)
- Lucene query (e.g. +author:ben* +tokenMorph:quantitas +tokenMorph:sum)
- supported fields
- docId
- identifier
- author
- title
- language
- publisher (place)
- date (year)
- subject
- rights
- license
- accessRights
- tokenOrig
- tokenReg
- tokenNorm
- tokenMorph
- default: tokenOrig
- sortBy (optional)
- fieldNames separated by blank
- supported fields
- author
- title
- language
- publisher (place)
- docId
- date (year)
- lastModified
- schemaName
- default: result is sorted by score (the most relevant result first)
- language (optional)
- ISO 639-3 specifier
- default: automatically derived from query
- translate (optional)
- expansion of the query: translation of the query terms to other languages
- true
- false
- default: false
- page (optional)
- result page number
- default: 1
- pageSize (optional)
- result page size
- default: 10
- outputFormat (optional)
- Response output
- Url: /mpiwg-mpdl-cms-web/query/QueryDocument
- Request parameters
- docId (required)
- document identifier (e.g. "/echo/la/Benedetti_1585.xml"
- query (required)
- Lucene query (e.g. +tokenMorph:quantitas +tokenMorph:sum)
- supported fields
- language
- pageNumber
- lineNumber
- elementName
- elementDocPosition (position in document, e.g. the 7th element in document)
- elementAbsolutePosition (position in all elements with this name, e.g. the 5th sentence in document)
- elementPagePosition (position of this element within a page, e.g. the 8th sentence on page 5)
- elementPosition (position of this element in parent element, e.g. the 3rd sentence element in a paragraph)
- xmlId
- xpath
- tokenOrig
- tokenReg
- tokenNorm
- tokenMorph
- default: tokenOrig
- page (optional)
- result page number
- default: 1
- pageSize (optional)
- result page size
- default: 10
- outputFormat (optional)
- Response output
- Url: /mpiwg-mpdl-cms-web/query/XQueryDocument
- Request parameters
- docId (required)
- document identifier (e.g. "/echo/la/Benedetti_1585.xml"
- query (required)
- page (optional)
- result page number
- default: 1
- pageSize (optional)
- result page size
- default: 10
- outputFormat (optional)
- Response output
- Url: /wspCmsWebApp/query/MoreLikeThis
- Request parameters
- docId (required)
- document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"
- page (optional)
- result page number
- default: 1
- pageSize (optional)
- result page size
- default: 10
- outputFormat (optional)
- xml
- html
- json
- default: html
- addInf (optional)
- result with additional information such as person names etc.
- true
- false
- default: false
- Response output
- Url: /mpiwg-mpdl-cms-web/query/GetToken
- Request parameters
- docId (optional)
- document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"
- attribute (optional)
- identifier
- author
- title
- language
- date
- rights
- license
- accessRights
- tokenOrig
- tokenReg
- tokenNorm
- tokenMorph
- default: tokenOrig
- query (optional)
- beginning characters of token (e.g. "a")
- default: empty (beginning alphabetically at first position in all tokens)
- count (optional)
- count of tokens
- default: 100
- outputFormat (optional)
- Response output
- Url: /mpiwg-mpdl-cms-web/query/GetDocInfo
- Request parameters
- docId (required)
- document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"
- field (optional)
- author
- title
- language
- date
- rights
- license
- accessRights
- countPages
- lastModified
- schema
- echoId
- toc (table of contents)
- figures
- notes
- notesHandwritten
- pages
- places
- default: null (all fields except automatic generated lists such as toc, figures, etc.)
- outputFormat (optional)
- Response output
- Url: /mpiwg-mpdl-cms-web/doc/GetDocumentJobs
- Request parameters
- id (optional)
- outputFormat (optional)
- Response output
- all document jobs (when parameter id is not set) or document job with the specified id
- Example: get all document jobs