API-M Methods v2.2
From FedoraWiki
(Redirected from API-M Methods)
[edit]
Fedora API-M Methods (for version 2.2)
NOTE:
* Please see UpgradingYourApplicationForFedora2.2 for a list of API changes for 2.2. * The official WSDL for Fedora 2.2 can be found at http://www.fedora.info/definitions/api * The documentation for version 2.1.1 (deprecated) is located on this page: API-M_Methods_v2.1.1 * The original API documenation pages for version 2.1.1 are still available (API-A) (API-M)
The Fedora Management service defines an open interface for administering the repository, including creating, modifying, and deleting digital objects, or components within digital objects. The Management service interacts with the underlying repository system to read content from and write content to the digital object and datastream storage areas. The Management service exposes a set of operations that enable a client to view and manipulate digital objects from an abstract perspective, meaning that a client does not need to know anything about underlying storage formats, storage media, or storage management schemes for objects. Also, the underlying repository system handles the details of storing datastream content within the repository, as well as mediating connectivity for datastreams that reference external content.
return to Fedora APIs
[edit]
Method Index
[edit]addDatastream
- Creates a new datastream in the object.
[edit]addDisseminator
- Creates a disseminator in the object.
[edit]compareDatastreamChecksum
- Will read in the digital content of the datastream, compute a checksum using the same checksum algorithm stored with the datastream, and compare the resulting value with the one it previously computed and stored in the digital object. If the two checksums are identical, the function will return the value of the checksum (which could then be stored externally, if desired, as an added measure of security). If the newly computed checksum doesn't match the stored one, the API function will return a message indicating this checksumming failure.
[edit]describeUser
- Gets key information about the named user.
[edit]export
- Exports the entire digital object in the specified XML format ("foxml1.0" or "metslikefedora1"), and encoded appropriately for the specified export context ("public", "migrate", or "archive").
[edit]exportObject
[edit]getDatastream
- Gets a datastream in an object.
[edit]getDatastreamHistory
- Gets all versions of a datastream, sorted from most to least recent.
[edit]getDatastreams
- Gets all the datastreams in an object as of a certain date/time and in a certain state.
[edit]getDisseminator
- Gets a disseminator in an object.
[edit]getDisseminatorHistory
- Gets the creation dates of each version of a disseminator.
[edit]getDisseminators
- Gets all disseminators in an object.
[edit]getNextPID
- Retrieves the specified number of next available pid(s) for a given pid namespace.
[edit]getObjectXML
- Gets the XML portion of the entire METS-encoded digital object for external use (viewing, editing, moving to another repository). XML metadata datastreams will be included inline, content datastreams will not be included, and external datastreams will be referenced by url.
[edit]ingest
- Creates a new digital object in the repository, given the data in the provided XML document, and a format indentifier for the XML document format. The valid formats are currently: "foxml1.0" and "metslikefedora1". The object's initial state will be A (active). If the XML document does not specify the OBJID attribute of the root element, the repository will generate and return a new pid for the object resulting from this request. That pid will have the namespace of the repository. If the XML document specifies a pid, it will be assigned to the digital object provided that 1) it conforms to the Fedora pid Syntax, 2) it uses a namespace that matches the "retainPIDs" value configured for the repository, and 3) it does not collide with an existing pid of an object in the repository.
[edit]ingestObject
[edit]modifyDatastreamByReference
- Modifies an existing datastream in an object, by reference.
[edit]modifyDatastreamByValue
- Modifies an existing datastream in an object, by value.
[edit]modifyDisseminator
- Modifies a disseminator in the object.
[edit]modifyObject
- Changes the state and/or label of the object.
[edit]purgeDatastream
- Permanently removes one or more versions of a datastream from an object.
[edit]purgeDisseminator
- Permanently removes one or more versions of a disseminator from an object.
[edit]purgeObject
- Permanently removes an object from the repository.
[edit]setDatastreamState
- Sets the state of a datastream to the specified state value.
[edit]setDatastreamVersionable
- Selectively turn versioning on or off for selected datastreams. When versioning is disabled, subsequent modifications to the datastream replace the current datastream contents and no versioning history is preserved.::
[edit]setDisseminatorState
- Sets the state of a disseminator to the specified value.
return to Fedora APIs
