Differences between revisions 57 and 58
Revision 57 as of 2008-10-16 15:41:48
Size: 1567
Editor: abr
Comment:
Revision 58 as of 2008-10-16 15:42:55
Size: 1688
Editor: abr
Comment:
Deletions are marked like this. Additions are marked like this.
Line 22: Line 22:
 * [:/DataStructures: The complex data types used in the APIs] - A requisite for understanding the two documents above.

Fedora 3.0 API

DOMS metadata objects will be stored in Fedora-commons 3.0.

The API is documented here, as far as it goes: http://www.fedora-commons.org/documentation/3.0/userdocs/index.html#webservices

The API to Fedora is directly exported as the primary API to DOMS. We have restricted a few methods, and have some conventions about certain other should be used.

The following methods are restricted

  • [:/Managment#PurgeDatastream: apiM.PurgeDatastream] and[:/Managment#PurgeObject: apiM.PurgeObject] are not allowed. Instead use [:Fedora_3.0_API/Managment#modifyDatastream: apiM.modifyDatastream] and [:Fedora_3.0_API/Managment#modifyObject: apiM.modifyObject] to change the state to "D" (deleted).

  • [:/Managment#setDatastreamVersionable: apiM.setDatastreamVersionable] is disallowed. The internal datastreams are always versioned.
  • Do not use getNextPID, instead use the method provided from DOMS

Objects that are marked as "published" (see FedoraTransactionsReplacement) cannot be changed. Any API calls that attempt to change them will fail. There will be made a service to atomically change the state of objects. TODO!!!

The Fedora API is described in the the pages below.

  • [:/Access: The public Access API] - Everybody can use this, this is the primary way for external applications to query the repository.
  • [:/Managment: The protected Managment API] - Only authenticated administrators, such as users of the GUI, can use this.
  • [:/DataStructures: The complex data types used in the APIs] - A requisite for understanding the two documents above.

  • [:/RIsearch: The Resource Index API] - The interface to the Fedora triple store.

Fedora 3.0 API (last edited 2010-03-17 13:12:49 by localhost)