Introduction
The Fedora API-M-Lite interface is implemented as an HTTP service that provides a simple URI-oriented definition for the Management service of a Fedora repository. It is intended to support a REST-like style of access to the Fedora Management 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 management service requests. API-M-LITE does not provide service bindings for all of the operations defined in Fedora's full Management service (API-M). Currently, API-M-LITE only provides bindings for the method listed below. Additional methods will be implemented for API-M-Lite in future releases of Fedora.
- getNextPID - gets a list of the requested next available PIDs.
For more information on the method definitions, refer to the API descriptions located at http://www.fedora.info/definitions/1/0/api/
Client Syntax
getNextPID syntax:
http://hostname:port/fedora/management/getNextPID? [numPIDs=NUMPIDS&]
[namespace=NAMESPACE&] [xml=BOOLEAN&]
This syntax requests a list of the next available PIDs. The result is returned
as a MIME-typed stream. Items enclosed in square brackets are optional.
- hostname - required hostname of the Fedora server.
- port - required port number on which the Fedora server is running. fedora - required name of the Fedora access service.
- fedora - a required parameter specifying the Fedora servlet path.
- management - a required parameter specifying the Fedora servlet path.
- numPIDs - a optional parameter specifying the number of PIDs to generate. If omitted, the value defaults to one.
- namespace - an optional parameter specifying the namespace to be used in generating the PIDs. If omitted, the value defaults to the value of the pidNamespace parameter in the fedora.fcfg configuration file.
- xml - an optional parameter indicating the format of the response. A value of "false" indicates the response format is HTML. A value of "true" indicates the response format is XML. If omitted, the value defaults to a value of "false".
Examples
Generate a single PID using the default namespace configured in the fedora.fcfg
file and return the results as HTML:
http://localhost:8080/fedora/management/getNextPID?
Generate five PIDs using the default namespace configured in the fedora.fcfg
file and return the results as HTML:
http://localhost:8080/fedora/management/getNextPID?numPIDs=5
Generate 5 PIDs using a namespace value of "my-namespace" and return the results
as HTML:
http://localhost:8080/fedora/management/getNextPID?numPIDs=5&namespace=my-namespace
Generate 5 PIDs using the namespace value of "my-namespace" and return the results
as XML:
http://localhost:8080/fedora/management/getNextPID?numPIDs=5&namespace=my-namespace&xml=true
WSDL
- Offline For reference, an offline copy of the API-M-LITE WSDL is available here.
- Online
When running your own Fedora server, an online copy of
the API-M-LITE WSDL will be made publicly available at
/wsdl?api=API-M-LITE. For example: http://localhost:8080/fedora/wsdl?api=API-M-LITE