|
Size: 3969
Comment:
|
Size: 1688
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| DOMS metadata objects will be stored in Fedora-commons 3.0. Fedora 3.0 is currently in beta 2, but is expected to be final by the time we release DOMS. | DOMS metadata objects will be stored in Fedora-commons 3.0. |
| Line 5: | Line 5: |
| The API is documented here: http://www.fedora-commons.org/documentation/3.0/userdocs/index.html#webservices | The API is documented here, as far as it goes: http://www.fedora-commons.org/documentation/3.0/userdocs/index.html#webservices |
| Line 7: | Line 7: |
| The following restrictions apply: | 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. |
| Line 9: | Line 9: |
| * The possibilities "PurgeDatastream" and "PurgeObject" are not allowed. Instead change the state to deleted * setDatastreamVersionable is disallowed. The internal datastreams are always versioned. |
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. |
| Line 13: | Line 15: |
| All ingested objects, and all updates, must lead to valid objects, as defined by the data model. The exception is that objects marked as "draft" or "intermediate" in the datamodel are always considered valid. | |
| Line 15: | Line 16: |
| Making a call to any API method that changes the object to a state not valid as defined by the datamodel will fail. Any call to a state-changing API-call where the object is not first set to intermediate state will fail. | 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!!! |
| Line 17: | Line 18: |
| == Examples == | The Fedora API is described in the the pages below. |
| Line 19: | Line 20: |
| === Saving seven new interrelated objects to DOMS === Since the datamodel may require that all seven objects are correctly ingested and interrelated before they are valid, ingest all seven objects in intermediate state, and then publish them * Call the method for generating DOMS PIDs seven times * Generate 7 FoxML objects, each with the administrative state set to "intermediate" * Call API-M {{{ingest}}} seven times * Call API-M {{{modifyDatastreamByValue}}} 7 times to update the state to "published" === Updating fields and references for 8 interrelated objects === To make sure that the changes don't interfere with validity, first set the state to intermediate, then update state to published after modifications. * Call API-M {{{modifyDatastreamByValue}}} 8 times to update the administrative state to "intermediate" * Update datastreams and relations as needed to make the changes using {{{addRelationsship}}}/{{{addDatastream}}}/{{{purgeRelationship}}}/{{{modifyDatastreamByValue}}}/{{{setDatastreamState}}} * Call API-M {{{modifyDatastreamByValue}}} 8 times to update the administrative state to "published" == Usage of Fedora API-M and API-A == The following describes those methods of the Fedora API-M and API-A that may be called by the GUI. === API-M === ==== addDatastream ==== Input parameters: * {{{String pid}}} The PID of the object. * {{{String dsID}}} The datastream ID (64 characters max). If null, Fedora will generate the value. * {{{String[] altIDs}}} Alternate identifiers for the datastream. * {{{String dsLabel}}} The label for the datastream. * {{{boolean versionable}}} Enable versioning of the datastream. * {{{String MIMEType}}} The mime-type of the datastream. * {{{String formatURI}}} The format URI of the datastream. * {{{String dsLocation}}} Location of managed or external datastream content. * {{{String controlGroup}}} One of "X", "M", "R", or "E" (Inline XML, Managed Content, Redirect, or External Referenced). * {{{String dsState}}} One of "A", "D", or "I" (Active, Deleted, or Inactive). * {{{String checksumType}}} The algorithm used to compute the checksum. One of "DEFAULT", "DISABLED", "MD5", "SHA-1", "SHA-256", "SHA-385", "SHA-512", "HAVAL", "TIGER", "WHIRLPOOL". * {{{String checksum}}} The value of the checksum represented as a hexadecimal string. * {{{String logMessage}}} A log message. Returns: * {{{String}}} The datastreamID of the newly added datastream. ==== addRelationship ==== ==== compareDatastreamChecksum ==== ==== getDatastream ==== ==== getDatastreams ==== ==== getRelationships ==== ==== ingest ==== ==== modifyDatastreamByReference ==== ==== modifyDatastreamByValue ==== ==== modifyObject ==== ==== purgeRelationship ==== ==== setDatastreamState ==== ==== (export) ==== ==== (getDatastreamHistory)? ==== ==== (getObjectXML)? ==== === API-A === |
* [:/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
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.