Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
bgColorwhite
borderStylenone

URL Syntax

/objects/ [{pid}| new] ? [label] [format] [encoding] [namespace] [ownerId] [logMessage] [ignoreMime] [state]

HTTP Method

POST

HTTP Response

201

Request Content

text/xml

Parameters

Name

Description

Default

Options

{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

 

 

statethe state of the object: active ("A") or inactive ("I")activeA, I

Notes

Executing this request with no request content will result in the creation of a new, empty object (with either the specified PID or a system-assigned PID). The new object will contain only a minimal DC datastream specifying the dc:identifier of the object.

Examples

POST: /objects/new

POST: /objects

POST: /objects/new?namespace=demo

POST: /objects/test:100?label=Test

...