Page History

{pid}

persistent identifier of the digital object

{dsID}

datastream identifier

asOfDateTime

indicates that the result should be relative to the digital object as it existed at the given date and time

yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ

download

If true,  a content-disposition header value "attachment" will be included in the response, prompting the user to save the datastream as a file.  A content-disposition header value "inline" will be used otherwise.  The filename used in the header is generated by examining in order: RELS-INT for the relationship fedora-model:downloadFilename, the datastream label, and the datastream ID.  The file extension (apart from where the filename is specified in RELS-INT) is determined from the MIMETYPE.  The order in which these filename sources are searched, and whether or not to generate an extension from the MIMETYPE, is configured in fedora.fcfg.  The file used to map between MIMETYPEs and extensions is mime-to-extensions.xml located in the server config directory.

{pid}

persistent identifier of the digital object

{sdefPid}

persistent identifier of the sDef defining the methods

{method}

method to invoke

method parameters

any parameters required by the method

format

the preferred output format

html

xml, html

{pid}

persistent identifier of the object to be created

new (see below)

new

indicator that either a new PID should be created for this object or that the PID to be used is encoded in the XML included as the body of the request

label

the label of the new object

format

the XML format of the object to be ingested

info:fedora/fedora-system:FOXML-1.1, info:fedora/fedora-system:FOXML-1.0, info:fedora/fedora-system:METSFedoraExt-1.1, info:fedora/fedora-system:METSFedoraExt-1.0, info:fedora/fedora-system:ATOM-1.1, info:fedora/fedora-system:ATOMZip-1.1

encoding

the encoding of the XML to be ingested.  If this is specified, and given as anything other than UTF-8, you must ensure that the same encoding is declared in the XML.  For example, if you specify "ISO-88591" as the encoding, the XML should start with:
<?xml version="1.0" encoding="ISO-8859-1"?> 

UTF-8

namespace

the namespace to be used to create a PID for a new empty object; if object XML is included with the request, the namespace parameter is ignored

the default namespace of the repository

ownerId

the id of the user to be listed at the object owner

logMessage

a message describing the activity being performed

ignoreMime

indicates that the request should not be checked to ensure that the content is XML prior to attempting an ingest. This is provided to allow for client applications which do not indicate the correct Content-Type when submitting a request.

false

true, false

XML file as request content

file to be ingested as a new object

{pid}

persistent identifier of the digital object

{dsID}

datastream identifier

dsLocation

location of datastream content

altIDs

alternate identifiers for the datastream

dsLabel

the label for the datastream

versionable

enable versioning of the datastream

the "versionable" property of the existing datastream

true, false

dsState

one of "A", "I", "D" (*A*ctive, *I*nactive, *D*eleted)

A

A, I, D

formatURI

the format URI of the datastream

checksumType

the algorithm used to compute the checksum

DEFAULT

DEFAULT, DISABLED, MD5, SHA-1, SHA-256, SHA-385, SHA-512

checksum

the value of the checksum represented as a hexadecimal string

mimeType

the MIME type of the content being added, this overrides the Content-Type request header

logMessage

a message describing the activity being performed

ignoreContent

tells the request handler to ignore any content included as part of the request, indicating that you do not intend to update the datasteam content. This is primarily provided to allow the use of client tools which always require content to be included as part of PUT requests.

false

true, false

lastModifiedDate

date/time of the last (known) modification to the datastream, if the actual last modified date is later, a 409 response is returned

multipart file as request content

file to replace existing datastream (for Managed datastreams)

{pid}

persistent identifier of the digital object

{dsID}

datastream identifier

versionable

enable versioning of the datastream

true

true, false

{pid}

persistent identifier of the digital object

asOfDateTime

indicates that the result should be relative to the digital object and the repository as it existed at the given date and time

yyyy-MM-dd or yyyy-MM-ddTHH:mm:ssZ