API:EPrints/Apache/REST - Revision history

https://wiki.ext-9.eprints-hosting.org/w/index.php?action=history&feed=atom&title=API%3AEPrints%2FApache%2FREST API:EPrints/Apache/REST - Revision history 2026-05-10T14:08:14Z Revision history for this page on the wiki MediaWiki 1.43.6 https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API:EPrints/Apache/REST&diff=15675&oldid=prev Pod2wiki at 15:48, 15 March 2023 2023-03-15T15:48:43Z

<p></p> <a href="https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API:EPrints/Apache/REST&diff=15675&oldid=13925">Show changes</a>

Pod2wiki https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API:EPrints/Apache/REST&diff=13925&oldid=prev Pod2wiki at 21:37, 14 December 2021 2021-12-14T21:37:22Z

<p></p> <table style="background-color: #fff; color: #202122;" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en-GB"> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 21:37, 14 December 2021</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l117">Line 117:</td> <td colspan="2" class="diff-lineno">Line 117:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> $rc = EPrints::Apache::REST::serve_field_single( $repository, $object, $rights_object, $field, $value, @path )</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> $rc = EPrints::Apache::REST::serve_field_single( $repository, $object, $rights_object, $field, $value, @path )</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>Servee single field representation by passing onto '''EPrints::Apache::REST::serve_subobject''', '''EPrints::Apache::REST::<del style="font-weight: bold; text-decoration: none;">serve_compund</del>''' or '''EPrints::Apache::REST::serve_name''' base on type of field.</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>Servee single field representation by passing onto '''EPrints::Apache::REST::serve_subobject''', '''EPrints::Apache::REST::<ins style="font-weight: bold; text-decoration: none;">serve_compound</ins>''' or '''EPrints::Apache::REST::serve_name''' base on type of field.</div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '></div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '></div></td></tr> <tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l143">Line 143:</td> <td colspan="2" class="diff-lineno">Line 143:</td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )</div></td></tr> <tr><td class="diff-marker" data-marker="−"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>Serves compound field by iterating over sub-field, calling '''EPrints::Apache::REST::serve_field_single <del style="font-weight: bold; text-decoration: none;">where appropriate</del>'''</div></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>Serves compound field by iterating over sub-field, calling '''EPrints::Apache::REST::serve_field_single''' <ins style="font-weight: bold; text-decoration: none;">where appropriate.</ins></div></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br></td></tr> <tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '></div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div><div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '></div></td></tr> </table>

Pod2wiki https://wiki.ext-9.eprints-hosting.org/w/index.php?title=API:EPrints/Apache/REST&diff=13924&oldid=prev Pod2wiki: Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'..." 2021-12-14T21:27:46Z

<p>Created page with "{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/REST.pm|package_name=EPrints::Apache::REST}}[[Category:API|REST]][[Category:API:EPrints/Apache|REST]]<div><br /> <br /> <br /> <br /> ==NAME==<br /> EPrints::Apache::REST - Representational state transfer<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==DESCRIPTION==<br /> REST API for EPrints<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==METHODS==<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===handler===<br /> <br /> $rc = EPrints::Apache::REST::handler( $r )<br /> Handler for EPrints' REST API<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===redir_add_slash===<br /> <br /> $rc = EPrints::Apache::REST::redir_add_slash( $repository )<br /> Redirect to the current request for the $repository with an added slash '/' at the end of the path.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_top_level===<br /> <br /> $rc = EPrints::Apache::Login::serve_top_level( $repository, @path )<br /> Serve top level list of datasets (i.e. eprint, user and subject) or pass onto '''EPrints::Apache::Login::serve_datasets'''. dependent of @path.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_dataset===<br /> <br /> $rc = EPrints::Apache::REST::serve_dataset( $repository, $dataset, @path )<br /> Serve listing of data objects for a particular dataset, pass onto '''EPrints::Apache::Login::serve_dataobj''', '''EPrints::Apache::Login::get_dataobj_xml''' or '''EPrints::Apache::Login::put_dataobj_xml''',or return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_dataobj===<br /> <br /> $rc = EPrints::Apache::REST::serve_dataobj( $repository, $object, $rights_object, @path )<br /> Servee HTML, XML or text version of data object from GET or PUT request, pass onto '''EPrints::Apache::REST::serve_field''' or otherwise return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_field===<br /> <br /> $rc = EPrints::Apache::REST::serve_field( $repository, $object, $rights_object, $field, $value, @path )<br /> Servee HTML, XML or text version of data object from GET requests passsingel field requests onto '''EPrints::Apache::REST::serve_field_single''' or otherwise return an appropriate HTTP error code.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_field_single===<br /> <br /> $rc = EPrints::Apache::REST::serve_field_single( $repository, $object, $rights_object, $field, $value, @path )<br /> Servee single field representation by passing onto '''EPrints::Apache::REST::serve_subobject''', '''EPrints::Apache::REST::serve_compund''' or '''EPrints::Apache::REST::serve_name''' base on type of field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_suboject===<br /> <br /> $rc = EPrints::Apache::REST::serve_suboject( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves sub-object by passing onto '''EPrints::Apache::REST::serve_dataobj'''.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_compound===<br /> <br /> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves compound field by iterating over sub-field, calling '''EPrints::Apache::REST::serve_field_single where appropriate'''<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===serve_compound===<br /> <br /> $rc = EPrints::Apache::REST::serve_compound( $repository, $object, $rights_object, $field, $value, @path )<br /> Serves name field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===render_html===<br /> <br /> $rc = EPrints::Apache::REST::render_html( $html, $title )<br /> Renders HTML for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_html===<br /> <br /> $rc = EPrints::Apache::REST::send_html( $repository, $html, $title )<br /> Sends HTML response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_html===<br /> <br /> $rc = EPrints::Apache::REST::send_html( $repository, $xmldata )<br /> Sends XML response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===send_html===<br /> <br /> $rc = EPrints::Apache::REST::send_html( $repository, $content )<br /> Sends plaintext response for REST request.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===allowed_methods===<br /> <br /> $allowed = EPrints::Apache::REST::allowed_methods( $repository, @methods )<br /> Checks if method for eequest is contained with the @methods array of allowed methods. Setting and sending HTTP response headers and code as appropriate.<br /> <br /> Returns boolean depending on whether the request method is allowed.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===allowed_methods===<br /> <br /> $allowed = EPrints::Apache::REST::allowed_methods( $priv $repository, $rights_object )<br /> Checks is privilege $priv is permitted for the current user and sets HTTP response code as appropriate.<br /> <br /> Returns boolean depending on whether current user has permitted privilege.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_dataobj_xml===<br /> <br /> $rc = EPrints::Apache::REST::get_dataobj_xml( $repository, $object, $rights_object )<br /> Returns XML ot REST request to get a data object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_dataobj_xml===<br /> <br /> $rc = EPrints::Apache::REST::put_dataobj_xml( $repository, $object, $rights_object )<br /> Returns XML to REST request to (non-implemented) put data object.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_field_text===<br /> <br /> $rc = EPrints::Apache::REST::get_field_text( $repository, $object, $rights_object, $field )<br /> Returns text to to REST request to get field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===get_field_xml===<br /> <br /> $rc = EPrints::Apache::REST::get_field_xml( $repository, $object, $rights_object, $field )<br /> Returns XML for REST request for a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_field_xml===<br /> <br /> $rc = EPrints::Apache::REST::put_field_xml( $repository, $object, $rights_object, $field )<br /> Returns XML for REST request to put a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ===put_field_txt===<br /> <br /> $rc = EPrints::Apache::REST::put_field_txt( $repository, $object, $rights_object, $field )<br /> Returns text for REST request to put a field.<br /> <br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> <br /> ==COPYRIGHT==<br /> {{API:Copyright}}<br /> <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '><br /> <span style='display:none'>User Comments</span><br /> <br /> <br /> <br /> <br /> </div><br /> </div>

Pod2wiki