API:EPrints/Apache/CRUD - Revision history

Pod2wiki at 15:23, 15 March 2023

2023-03-15T15:23:12Z

← Older revision		Revision as of 15:23, 15 March 2023
Line 413:		Line 413:
	====generate_error_document====		====generate_error_document====

	$error_document = EPrints::Apache::~~Crud~~::generate_error_document( $repo, %opts )		$error_document = EPrints::Apache::CRUD::generate_error_document( $repo, %opts )
	Return error document for [[API:EPrints/Repository\|EPrints::Repository]] <tt>$repo</tt> using options from <tt>%opts</tt>.		Return error document for [[API:EPrints/Repository\|EPrints::Repository]] <tt>$repo</tt> using options from <tt>%opts</tt>.

Line 426:		Line 426:
	====is_true====		====is_true====

	$boolean = EPrints::Apache::~~Crud~~::is_true( $header )		$boolean = EPrints::Apache::CRUD::is_true( $header )
	Tests if <tt>$header</tt> attribute is <tt>true</tt>.		Tests if <tt>$header</tt> attribute is <tt>true</tt>.

Line 439:		Line 439:
	====is_false====		====is_false====

	$boolean = EPrints::Apache::~~Crud~~::is_false( $header )		$boolean = EPrints::Apache::CRUD::is_false( $header )
	Tests if <tt>$header</tt> attribute is <tt>false</tt>.		Tests if <tt>$header</tt> attribute is <tt>false</tt>.

Line 1,133:		Line 1,133:
	<!-- Pod2Wiki= -->		<!-- Pod2Wiki= -->
	</div>		</div>
	<!-- Pod2Wiki=~~item_$boolean~~ -->		<!-- Pod2Wiki=item_sword_error -->
	====~~$boolean~~====		====sword_error====

	$boolean = $crud->( %opts )		$boolean = $crud->sword_error( %opts )
	Generate SWORD error documents based on provided <tt>%opts</tt>.		Generate SWORD error documents based on provided <tt>%opts</tt>.

Pod2wiki at 15:21, 15 March 2023

2023-03-15T15:21:51Z

@@ Line 394: / Line 394: @@
 Return a new CRUD request using parameters given in <tt>%params</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>
@@ Line 1,051: / Line 1,099: @@
 Returns HTTPS response code based on whether request on behalf of is  permitted.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 1,129: / Line 1,151: @@
   $boolean = $crud-&gt;plugin_error( $plugin, $messages )
 Generate error message for import <tt>$plugin</tt> used with <tt>$messages</tt> provided.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Pod2wiki at 15:13, 15 March 2023

2023-03-15T15:13:15Z

Show changes

Pod2wiki at 21:08, 14 December 2021

2021-12-14T21:08:44Z

Show changes

Drn@ecs.soton.ac.uk: Added info about PUT and PATCH in 3.4

2021-10-13T08:14:18Z

Added info about PUT and PATCH in 3.4

← Older revision		Revision as of 08:14, 13 October 2021
Line 205:		Line 205:

	If you have the <em>upsert</em> privilege objects will be created on demand, otherwise attempting to PUT to a non-existant object will result in an error.		If you have the <em>upsert</em> privilege objects will be created on demand, otherwise attempting to PUT to a non-existant object will result in an error.

			Since EPrints 3.4, PUT is now designed to replace all existing metadata with the metadata provided in the request, so if a field is not included in the request it will become unset in the object. If you only want to update and/or insert particular fields you should use PATCH.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tommying@caltech.edu at 17:04, 15 March 2013

2013-03-15T17:04:14Z

@@ Line 67: / Line 67: @@
    HTTP/1.1 201 Created
    Content-Type: application/atom+xml;charset=utf-8
    ...</pre>

Tdb01r at 09:56, 22 January 2013

2013-01-22T09:56:31Z

← Older revision		Revision as of 09:56, 22 January 2013
Line 44:		Line 44:
	Create a new eprint based on a single file:		Create a new eprint based on a single file:

	<pre> curl -x POST \		<pre> curl -X POST \
	-i \		-i \
	-u user:password \		-u user:password \
Line 348:		Line 348:
	</source>		</source>
	Check the Packaging header is ok, if given.		Check the Packaging header is ok, if given.

			<!-- Edit below this comment -->


			<!-- Pod2Wiki= -->
			<!-- Pod2Wiki=head_resolve_relations -->
			===resolve_relations===

			<source lang="perl">$dataobj = $crud->resolve_relations( $dataobj [, @relations ] )

			</source>
			Resolve the relation path from $dataobj and return the resulting dataobj.

			Returns undef if there is no such related object.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->

Tdb01r at 10:45, 2 April 2012

2012-04-02T10:45:13Z

Show changes

Tdb01r at 10:42, 2 April 2012

2012-04-02T10:42:58Z

Show changes

Tdb01r at 10:35, 2 April 2012

2012-04-02T10:35:34Z

← Older revision		Revision as of 10:35, 2 April 2012
Line 139:		Line 139:

	* /id/document/.../contents		* /id/document/.../contents
	: Requesting the <em>/contents</em> of a {{API:PodLink\|file=EPrints/DataObj/Document\|package_name=EPrints::DataObj::Document\|section=\|text=Document}} will return the content of the document's main file.		: Requesting the <em>/contents</em> of a {{API:PodLink\|file=EPrints/DataObj/Document\|package_name=EPrints::DataObj::Document\|section=\|text=Document}} object will return the content of the document's main file.

	* /id/file/...		* /id/file/...
	: Requesting a {{API:PodLink\|file=EPrints/DataObj/File\|package_name=EPrints::DataObj::File\|section=\|text=File}} object with no <em>Accept</em> header (or ''/'') will return the file's content.		: Requesting a {{API:PodLink\|file=EPrints/DataObj/File\|package_name=EPrints::DataObj::File\|section=\|text=File}} object with no <em>Accept</em> header (or '''/''') will return the file's content.

	* POST /id/.../contents		* POST /id/.../contents
	: When creating new records via POST content negotiation is performed against the Import plugins.		: When creating new records via POST, content negotiation is performed against the Import plugins.

	: If no Import plugin supports the <em>Content-Type</em> header the content will be treated as ~~<em>~~application/octet-stream~~</em>~~ and stored in a new object. The resulting Atom entry will describe the new object (e.g. the <em>eprint</em> object in which the new <em>document</em> and <em>file</em> objects were created).		: If no Import plugin supports the <em>Content-Type</em> header the content will be treated as '''application/octet-stream''' and stored in a new object. The resulting Atom entry will describe the new object (e.g. the <em>eprint</em> object in which the new <em>document</em> and <em>file</em> objects were created).

	: ~~If an Import plugin matches~~ the result will depend on the plugin's output. Import plugins may produce a single object, ~~if the output is only an object,~~ or an object plus content file(s).		: Otherwise, the result will depend on the Import plugin's output. Import plugins may produce a single object, multiple objects or an object plus content file(s).

	* Content-Type header		* Content-Type header
	: If no <em>Content-Type</em> header is given the MIME type defaults to '''application/octet-stream'''.		: If no <em>Content-Type</em> header is given the MIME type defaults to '''application/octet-stream''' for POSTs and PUTs.

	* Content-Disposition header		* Content-Disposition header
	: If the <em>Content-Disposition</em> header is missing or does not contain a <em>filename</em> parameter the filename ~~will be set~~ to ''main.bin''.		: If the <em>Content-Disposition</em> header is missing or does not contain a <em>filename</em> parameter the filename defaults to ''main.bin'' for POSTs and PUTs.

	<!-- Edit below this comment -->		<!-- Edit below this comment -->