wsdl.Fedora-API-A-LITE.wsdl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fcrepo-client Show documentation
Show all versions of fcrepo-client Show documentation
The Fedora Client is a Java Library that allows API access to a Fedora Repository. The client is typically one part of a full Fedora installation.
The newest version!
a string value of "true" or "false" indicating that the repository info should be XML encoded.
Fedora will assume a default of "false" if the xml part is not specified.
The repository info response contains key metadata about the Fedora
repository server including repository name, version, baseURL, pid namespace, and
sample request URLs. The repository info will be returned as either XML or HTML.
the persistent identifier of the object.
the date/time stamp specifying the desired view of the
object. If this part is not present in the request, or if it is empty, the current
view of the object (the most recent time) is assumed.
a string value of "true" or "false" indicating that the list of object methods should be XML encoded.
Fedora will assume a default of "false" if the xml part is not specified.
The object profile response contains key metadata about the object
and URLs for the object's Dissemination Index and Item Index. The object
profile will be returned as either XML or HTML.
the pid of the object.
the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.
A set of method definitions that represent
all possible disseminations that can be run on the object.
the pid of the object.
the date/time stamp specifying the desired view of the
object. If null, the current view of the object (the most recent time)
is assumed.
A set of method definitions that represent
all possible disseminations that can be run on the object.
the persistent identifier of the object.
the identifier of the datastream to get.
the date/time stamp specifying that the dissemination should reflect
what the object looked like at a certain date and time. If this part is not present
in the request, or if it is empty, the current view of the object (the most recent time)
is assumed.
the datastream as a mime-typed stream.
the persistent identifier of the object.
the persistent identifier of the behavior definition.
the name of the behavior method to invoke.
the date/time stamp specifying that the dissemination should reflect
what the object looked like at a certain date and time. If this part is not present
in the request, or if it is empty, the current view of the object (the most recent time)
is assumed.
a set of name-value pairs that are parameters to the behavior method.
the desired view of the object as a mime-typed stream.
a sequence of characters (including the ? and * wildcards)
for the search. If this sequence is found in any of the fields for an
object, the object is considered a match. This parameter cannot
be used in combination with the query parameter.
a sequence of space-separated conditions. A condition
consists of a field name followed directly by an operator, followed
directly be a value. Valid field names are (pid, label, fType, cModel,
state, ownerId, cDate, mDate, dcmDate, bDef, bMech, title, creator, subject,
description, publisher, contributor, date, type, format, identifier,
source, language, relation, coverage, rights).
Valid operators are =, ~, >, >=, <, <=. The contains (~) operator
may be used in combination with the ? and * wildcards to query for simple
string patterns. The inequality operators should only be used with
date-based fields (cDate, mDate, dcmDate, date).
Values may be any string. If the string contains a space, the
value should begin and end with a single quote character ('). If all conditions
are met for an object, the object is considered a match. This parameter
cannot be used in combination with the terms parameter.
the maximum number of results that the server should
provide at once. If this is unspecified, the server will default
to a small value.
whether to return the result as an xml document. If this is
given as true, the result will be in xml. Otherwise, the result will be
provided in a simple html document.
if true, the pids of matching objects will be included in the response.
if true, the labels of matching objects will be included in the response.
if true, the fedora object types of matching objects will be included in the response.
if true, the content models of matching objects will be included in the response.
if true, the states of matching objects will be included in the response.
if true, the userids of users who own the objects will be included in the response.
if true, the create date of objects will be included in the response.
if true, the modified date of objects will be included in the response.
if true, the modified date of the dublin core record for the objects will be included in the response.
if true, the dc:titles of the objects will be included in the response.
if true, the dc:creators of the objects will be included in the response.
if true, the dc:subjects of the objects will be included in the response.
if true, the dc:descriptions of the objects will be included in the response.
if true, the dc:publishers of the objects will be included in the response.
if true, the dc:contributors of the objects will be included in the response.
if true, the dc:dates of the objects will be included in the response.
if true, the dc:types of the objects will be included in the response.
if true, the dc:formats of the objects will be included in the response.
if true, the dc:identifiers of the objects will be included in the response.
if true, the dc:sources of the objects will be included in the response.
if true, the dc:languages of the objects will be included in the response.
if true, the dc:relations of the objects will be included in the response.
if true, the dc:coverages of the objects will be included in the response.
if true, the dc:rights of the objects will be included in the response.
An xml chunk containing an array of ObjectFields and, possibly,
a listSession.
the token of the session in which the next few
results can be found.
whether to return the result as an xml document. If this is
given as true, the result will be in xml. Otherwise, the result will be
provided in a simple html document.
the persistent identifier of the object.
a string value of "true" or "false" indicating that the list of timestamps should be XML encoded. Fedora will assume a default of "false" if the xml part is not specified.
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 of the object to view the object as it appeared on a specific date and to indicate the change history of the object.The list of timestamps will be returned as either XML or HTML.
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.
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.
URL Syntax:
http(s)://host:port/fedora/describe?{xml=boolean}
A complete example URL conforming to this syntax is:
http://localhost:8080/fedora/describe?xml=true
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.
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.
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.
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.
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.
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.
URL Syntax:
http(s)://host:port/fedora/search?{terms=TERMS|query=QUERY}&maxResults=MAXRESULTS
&xml=true&pid=true&label=true&fType=true&cModel=true&state=true&ownerId=true
&cDate=true&mDate=true&dcmDate=true&bDef=true&bMech=true&title=true
&creator=true&subject=true&description=true&publisher=true&contributor=true
&date=true&type=true&format=true&identifier=true&source=true&language=true
&relation=true&coverage=true&rights=true
A couple complete example URLs conforming to this syntax, are:
http://localhost:8080/fedora/search?terms=fedora&pid=true
This example requests that the server provide the pids of objects where any of the indexed fields contain the word fedora.
Since maxResults and xml aren't specified, the maxResults the server uses will be a small number, and the result will
be provided in html.
http://localhost:8080/fedora/search?query=pid~*1&maxResults=50&xml=true&pid=true&creator=true
This example requests that the server provide the pids and dc:creators of objects where the pid ends with the number 1.
It asks for up to 50 results at a time from the server, and requests that the result is provided in xml.
At least one of the object fields should be specified as true. Object fields are the optional fields
beginning with pid, above. The result of the search will be a simple HTML document if
the xml parameter is not specified. If it is, the result will look like:
<result>
<listSession>
<token>abcdef123456</token>
<cursor>0</cursor>
<completeListSize>500</completeListSize>
<expirationDate>2003-03-04T12:53:00Z</expirationDate>
</listSession>
<resultList>
<objectFields>
<pid>demo:5</pid>
<bDef>demo:1</bDef>
<bDef>demo:3</bDef>
<subject>My Subject</subject>
...
</objectFields>
...
</resultList>
</result>
...where dots indicate possible repeating elements in the xml. The listSession element is only provided if the result is a partial result. (See resumeFindObjects below)
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.
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.
This URL replacement syntax is used to request a description
of the Fedora repository server. The request will return key metadata elements
about the repository server including repository name, version, baseURL,
pid namespace, and sample request URLs. When putting together a proper URL,
the client should replace parenthesized parts of the operation location URL with actual values.
For example, "(boolean)" should be replaced with a "true" or "false" to indicate
whether the repository information should be returned as XML (alternative is HTML).
Parts of the operation location URL that are surrounded by brackets ("[ ]") are optional.
To construct a proper URL the client must replace the following variables with real information:
- boolean : an optional parameter. Client can specify that the output of
the operation be HTML or XML. A value of "true" indicates a return type of
text/xml; the absence of the boolean parameter or a value of "false" indicates
format is to be text/html.
This URL replacement syntax is used to request the object profile.
When putting together a proper URL, the client should replace parenthesized
parts of the operation location URL with actual values. For example, "(pid)"
should be replaced with an actual pid of an object for which the client wants
to get information about (e.g. uva-lib:10). Parts of the operation location URL that
are surrounded by brackets ("[ ]") are optional. To construct a proper URL the
client must replace the following variables with real information:
- pid : a required parameter. Client must provide the persistent identifier of the object.
- asOfDateTime : an optional parameter. Client can specifiy a dateTime value
indicating that the client wants the object profile to reflect how the object looked
as of a particular date and time.
- boolean : an optional parameter. Client can specify that the output of
the operation be HTML or XML. A value of "true" indicates a return type of
text/xml; the absence of the boolean parameter or a value of "false" indicates
format is to be text/html.
This URL replacement syntax is used to request the list of all
methods within a digital object.
When putting together a proper URL, the client should replace parenthesized
parts of the operation location URL with actual values. For example, "(pid)"
should be replaced with an actual pid of an object for which the client wants
to get information about (e.g. uva-lib:10). Parts of the operation location URL that
are surrounded by brackets ("[ ]") are optional. To construct a proper URL the
client must replace the following variables with real information:
- pid : a required parameter. Client must provide the persistent identifier of the object.
- asOfDateTime : an optional parameter. Client can specifiy a dateTime value
indicating that the client wants the object profile to reflect how the object looked
as of a particular date and time.
- boolean : an optional parameter. Client can specify that the output of
the operation be HTML or XML. A value of "true" indicates a return type of
text/xml; the absence of the boolean parameter or a value of "false" indicates
format is to be text/html.
This URL replacement syntax is used to request a list of all
datastream in a digital object.
When putting together a proper URL, the client should replace parenthesized
parts of the operation location URL with actual values. For example, "(pid)"
should be replaced with an actual pid of an object for which the client wants
to get information about (e.g. uva-lib:10). Parts of the operation location URL that
are surrounded by brackets ("[ ]") are optional. To construct a proper URL the
client must replace the following variables with real information:
- pid : a required parameter. Client must provide the persistent identifier of the object.
- asOfDateTime : an optional parameter. Client can specifiy a dateTime value
indicating that the client wants the object profile to reflect how the object looked
as of a particular date and time.
- boolean : an optional parameter. Client can specify that the output of
the operation be HTML or XML. A value of "true" indicates a return type of
text/xml; the absence of the boolean parameter or a value of "false" indicates
format is to be text/html.
- pid : a required parameter. The pid of the digital object.
- dsID : a required parameter. The ID of the datastream in the object.
This URL replacement syntax is used to request a dissemination of the object.
When putting together a proper URL, the client should replace parenthesized
parts of the operation location URL with actual values. For example, "(pid)"
should be replaced with an actual pid of an object that the client wants to request a
dissemination of (for example a pid value of "uva-lib:10"). Those parts of the operation
location syntax that are surrounded by brackets ("[ ]") are optional.
To construct a proper URL the client must replace the following variables with real information:
- pid : a required parameter. Client must provide the persistent identifier of the digital object.
- bDefPid : a required parameter. Client must provide the persistent identifier of the
behavior definition object to which the digital object subscribes.
- methodName - a required parameter. Client must provide the name of the behavior
method to be executed. A behavior method is also known as a dissemination method.
- asOfDateTime : an optional parameter. Client can specifiy a dateTime value
indicating that the client wants the object profile to reflect how the object looked
as of a particular date and time.
- parameters - an optional array of parameters to the behavior method. The parameter array
must begin with a question mark to delimit it from the rest of the URL. Then, the
parameters follow as a set of name/value pairs separated by ampersands.
Each name and value is connected by an equal sign. This is in accordance with normal
URL syntax for encoding parameters.
This URL replacement syntax is used to perform a search on the objects in the repository.
The brace ({ and }) characters are used to denote a choice between items separated by the pipe (|) character.
Parentheses around a string indicate that the value of that part of the url should be replaced with the
value of the named parameter. Square brackets indicate optional text.
Descriptions of each named parameter can be found in the appropriate message part documentation above.
This operation is used to resume a findObjects operation.
The sessionToken value comes from the previous response. The URL replacement
uses the same syntax conventions as the findObjects operation.
This URL replacement syntax is used to request the object change history request.
When putting together a proper URL, the client should replace parenthesized
parts of the operation location URL with actual values. For example, "(pid)"
should be replaced with an actual pid of an object for which the client wants
to get information about (e.g. uva-lib:10). Parts of the operation location URL that
are surrounded by brackets ("[ ]") are optional. To construct a proper URL the
client must replace the following variables with real information:
- pid : a required parameter. Client must provide the persistent identifier of the object.
- boolean : an optional parameter. Client can specify that the output of
the operation be HTML or XML. A value of "true" indicates a return type of
text/xml; the absence of the xml parameter or a value of "false" indicates
format is to be text/html.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy