API-A-Lite Methods
From FedoraWiki
==Fedora API-A-Lite Methods==
NOTE:
* THIS DOCUMENT IS OUT OF DATE. It currently reflects version 2.1.1 of Fedora. * 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
This is a simple URI-oriented service definition for the Access service of a Fedora repository. It is intended to support a REST-like style of access to the Fedora Access web service (in contrast to a traditional SOAP web service definition). This means that we define a simple URL syntax that can be used to issue service requests. API-A-Lite does not provide service bindings for all of the operations defined in Fedora's full Access service (API-A). API-A-Lite only provides bindings for getDissemination, getObjectProfile, findObjects, and resumeFindObjects. The result of the getDissemination request is a MIME-typed stream. The result of the getObjectProfile request is either HTML or XML, whichever the client requested. The result of the search methods is also either HTML or XML. When URL syntax is shown below, green indicates required parts and red indicates optional parts.
return to Fedora APIs
Contents |
Method Index
[edit]describeRepository
- Gets key metadata elements about the Fedora repository server including repository name, version, baseURL, pid namespace, and sample request URLs. The repository info can be returned as XML data or as an HTML presentation.
[edit]findObjects
- Gets the requested ObjectFields on all objects in the repository matching the given criteria. This is like a SQL query on a table that indexes all objects in the repository with key fields, including unqualified dublin core metadata.
[edit]getDatastreamDissemination
- Gets a datastream in the digital object. This is a shorter, convenience method for getDissemination http(s)://hostname:port/fedora/get/pid/fedora-system:3/getItem?itemID=dsID. Note that if a particular date/timestamped view of a datastream is needed, getDissemination still must be used. When making direct links to datastreams within web pages or applications, this syntax is recommended.
[edit]getDissemination
- Gets a MIME-typed view of the digital object, given the behavior definition id, the behavior method name and any parameters to the behavior method. The getDissemination request hides from the client the details of how a behavior method is fulfilled by the Fedora Access service (i.e., it does not require the client to know about the behavior mechanism that performs the work, or how the request is invoked upon the behavior mechanism). The client need only specify an abstract behavior definition information in the request
[edit]getObjectHistory
- Provides a list of timestamps indicating when a component of the object was created or modified. These timestamps can be used to request timestamped disseminations providing views of the object on a specific date. The list of timestamps can be returned as XML data or as an HTML presentation.
[edit]getObjectProfile
- Gets a profile of the digital object, which contains key metadata elements about the object, and URLs for the object's Dissemination Index and Item Index. The object profile is a sort of "home base" for the object from which the object can be investigated. The object profile can be returned as XML data or as an HTML presentation.
[edit]listDatastreams
- Inquires upon all object Datastreams to obtain datastreams contained by a digital object. This returns a set of datastream locations that represent all possible datastreams available in the object.
[edit]listMethods
- Inquires upon all object Disseminators to obtain Behavior Definition pids, and methodNames supported by a digital object. This returns a set of method definitions that represent all possible disseminations that can be run on the object.
[edit]resumeFindObjects
- Gets the next list of results from a truncated findObjects response. When a call to findObjects returns only part of a result, it will provide a session token that can be used to get the next chunk of results. Repeated calls to resumeFindObjects can then be made, until no listSession element is given in the response. When the result is requested in html format, the "next" button causes this method to be invoked. The url syntax for this method is the same as that for findObjects, but with the parameters below. sessionToken is required and xml is optional.
return to Fedora APIs
