Old Release

This documentation covers an old version of Fedora. Looking for another version? See all documentation.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

/rest/fcr:sitemap
/rest/fcr:search
/rest/fcr:namespaces

/rest/fcr:nextPID
- POST mints an ID

Nodes

/rest/{path}
- GET lists children, with optional filter by mixin
- POST create a new node of QueryParam "mixin" at {path}
- PUT mutate the object at {path}
- DELETE remove the object at {path}

GET /rest/
  list the top-level objects in the repository
 
GET /rest/objects/sufia:123456789
  list the children under /objects/sufia:123456789, which may include properties(?), datastreams or additional fedora objects/collections
 
GET /rest/some-other-object-living-at-jcr-root
  there's nothing special about /objects, it's just another part of the path to an object. List the children under /some-other-object-living-at-jcr-root, which may include properties(?), datastreams or additional fedora objects/collections
 
GET /rest/objects/sufia:123456789?mixin=fedora:datastream
  only list the `fedora:datastreams` that are children of /objects/sufia:123456789
 
POST /rest/objects/islandora:xyzasdf with request body
  (I seem to remember something about a JSON/XML serialization of "profile" properties...)
 
POST /rest/objects/islandora:xyzasdf?mixin=fedora:object
  create a new fedora object at /objects/islandora:xyzasdf
 
POST /rest/objects/islandora:xyzasdf/an/arbitrary/hierarchy/to/an/islandora:datastream?mixin=fedora:datastream
  create a new datastream at /objects/islandora:xyzasdf/an/arbitrary/hierarchy/to/an/islandora:datastream in the JCR tree. (Will this create all the intermediate nodes? do I need to do this manually?)
 
PUT /rest/objects/sufia:123456789
  (not sure what this implies.. manipulating properties of the node?)
 
DELETE /rest/objects/sufia:123456789
  Delete the node at /objects/sufia:123456789

 

/rest/{path}/fcr:new
- POST create a new child of QueryParam "mixin" under {path}

POST /rest/objects/fcr:new
  create a new child object with an automatically generated unique identifier
 
POST /rest/objects/sufia:123456789?mixin=fedora:datastream
  create a new child datastream for /objects/sufia:123456789 with an automatically generated unique identifier


/rest/{path}/fcr:content
- GET the bytes from {path}/jcr:content/jcr:data
- POST create a new nt:file at {path} with a binary value of the request entity
- PUT mutate the binary value of the nt:file at {path}
- DELETE remove the jcr:content child from the node at {path}

 

GET /rest/objects/sufia:123456789/DS1/fcr:content
  get the binary content of DS1
 
POST /rest/objects/sufia:123456789/THUMBNAIL/fcr:content (with a request body)
  add the binary content from the request body to THUMBNAIL
 
PUT /rest/objects/sufia:123456789/THUMBNAIL/fcr:content (with a request body)
  update the binary content in the THUMBNAIL
 
DELETE /rest/objects/sufia:123456789/THUMBNAIL/fcr:content
  remove the binary content from THUMBNAIL (but leave the JCR node there..)
 
PATCH /rest/objects/sufia:123456789/THUMBNAIL/fcr:content
  (I assume PATCH will work.. that'd be pretty cool)

 

/rest/{path}/fcr:new/fcr:content
- POST create a new nt:file under {path} with a binary value of the request entity

POST /rest/objects/sufia:123456789/fcr:new/fcr:content
  create a new child datastream (with an automatically generated unique identifier) with the content provided by the request body

Describe

/rest/{path}/fcr:describe
- GET profile or description [repo describe at root, profiles by type]
- POST unsupported?
- PUT unsupported?
- DELETE unsupported?

GET /rest/fcr:describe
  describe the fcrepo4 repository

GET /rest/objects/sufia:123456789/fcr:describe
  describe the object /objects/sufia:123456789 (equivalent to the fcrepo 3.x "object profile") 

GET /rest/objects/sufia:123456789/content/fcr:describe
  describe the datastream /objects/sufia:123456789/content (equivalent to the fcrepo 3.x "datastream profile")

GET /rest/some/arbitrary/jcr\:path/to/sufia:123456789/the/tree/continues/fcr:describe
  describe the node at /some/arbitrary/jcr\:path/to/sufia:123456789/the/tree/continues (equivalent to the fcrepo3.x "datastream profile"). 
  If the node resolves to a JCR "nt:file", we treat it as a datastream. Else, an object (or collection)

 

Versioning

/rest/{path}/fcr:versions
- GET the version history of the nt:file or the nt:folder (as appropriate) at {path}

GET /rest/objects/sufia:123456789/fcr:versions
  get the version history of /objects/sufia:123456789 fedora object (not sure what the response looks like, though)
 
GET /rest/sufia:123456789/THUMBNAIL/fcr:versions
  get the version history of the THUMBNAIL datastream

 

Datastream Batch Operations

/rest/{path}/fcr:datastreams is only for batch DS operations
- GET
- POST
- DELETE

GET /rest/objects/sufia:123456789/fcr:datastreams?dsid=DC&dsid=RELS-EXT&dsid=CONTENT_METADATA
  receive a multipart/mixed response of the 3 named datastreams under /objects/sufia:123456789
 
POST /rest/objects/sufia:123456789/fcr:datastreams (with a multipart body)
  create any number of datastreams under /objects/sufia:123456789
 
DELETE /rest/objects/sufia:123456789/fcr:datastreams?dsid=THUMBNAIL&dsid=CONTENT
  delete the two named datastreams under /objects/sufia:123456789

 

Fixity

/rest/{path}/fcr:fixity
- GET get the fixity report for the nt:file at {path}

GET /rest/objects/sufia:123456789/THUMBNAIL/fcr:fixity
  retrieve the fixity report for the /objects/sufia:123456789/THUMBNAIL node

 

 

  • No labels