Include Page | ||||
---|---|---|---|---|
|
...
- 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. Can be null.Wiki Markup - String dsLabel The label for the datastream. Can be null.
- boolean versionable Enable versioning of the datastream.
- String MIMEType The mime-type of the datastream. Can be null.
- String formatURI The format URI of the datastream. Can be null
- String dsLocation Location of managed, redirect, or external referenced datastream content.
- String controlGroup One of "X", "M", "R", or "E" (Inline XML, Managed Content, Redirect, or External Referenced). Required
- String dsState One of "A", "D", or "I" (Active, Deleted, or Inactive).
- String checksumType The algorithm used to compute the checksum. Possible values are MD5, SHA-1, SHA-256, SHA-386, SHA-512, DISABLED
- String checksum The value of the checksum represented as a hexadecimal string. Can be null.
- String logMessage A log message.
...
- Datastream:
- DatastreamControlGroup controlGroup - String restricted to the values of "X", "M", "R", or "E" (InlineXML,Managed Content,Redirect, or External Referenced).
- String ID - The datastream ID (64 characters max).
- String versionID - The ID of the most recent datastream versionunmigrated-wiki-markup
- _String\[\] altIDs_ \ - Alternative IDs for the datastream, if any.
- String label - The Label of the datastream.
- boolean versionable - Whether the datastream is versionable.
- String MIMEType - The mime-type for the datastream, if set.
- String formatURI - The format uri for the datastream, if set.
- String createDate - The date the first version of the datastream was created.
- long size - The size of the datastream in Fedora. Only valid for inline XML metadata and managed content datastreams.
- String state - The state of the datastream. Will be "A" (active), "I" (inactive) or "D" (deleted).
- String location - If the datastream is an external reference or redirect, the url to the contents. TODO: Managed?
- String checksumType - The algorithm used to compute the checksum. One of "DEFAULT", "DISABLED", "MD5", "SHA-1", "SHA-256", "SHA-385", "SHA-512".
- String checksum - The value of the checksum represented as a hexadecimal string.
...
- String pid The pid of the object.
- String dsID The datastream ID
Returns:
...
- _Datastream\[\]_ See [#getDatastream]
getDatastreams
Anchor | ||||
---|---|---|---|---|
|
...
- String pid The pid of the object.
- String asOfDateTime The date/time stamp specifying the desired version of the object. If null, the current version of the object (the most recent time) is assumed.
- String dsState One of "A", "D", or "I" (Active, Deleted, or Inactive).
Returns:
...
- _Datastream\[\]_ See [#getDatastream]
modifyDatastreamByReference
Anchor | ||||
---|---|---|---|---|
|
...
- String pid The PID of the object.
- String dsID The datastream ID.
_String\[\] altIDs_ Alternate identifiers for the datastream, if any.Wiki Markup - String dsLabel The label for the datastream.
- String MIMEType The mime type.
- String formatURI Optional format URI of the datastream.
- String dsLocation Location of managed, redirect, or external referenced datastream content.
- String checksumType The algorithm used to compute the checksum. One of "DEFAULT", "DISABLED", "MD5", "SHA-1", "SHA-256", "SHA-385", "SHA-512".
- String checksum The value of the checksum represented as a hexadecimal string.
- String logMessage A log message.
- boolean force Deprecated. Force the update even if it would break a data contract.
...
- String pid The PID of the object.
- String dsID The datastream ID.unmigrated-wiki-markup
- _String\[\] altIDs_ Alternate identifiers for the datastream, if any.
- String dsLabel The label for the datastream.
- String MIMEType The mime type.
- String formatURI Optional format URI of the datastream.
- String dsContent The content of the datastream.
- String checksumType The algorithm used to compute the checksum. One of "DEFAULT", "DISABLED", "MD5", "SHA-1", "SHA-256", "SHA-385", "SHA-512".
- String checksum The value of the checksum represented as a hexadecimal string.
- String logMessage A log message.
- boolean force Deprecated. Force the update even if it would break a data contract.
...
- String subject The subject. Either a Fedora object URI (eg info:fedora/demo:333) or a datastream URI (eg info:fedora/demo:333/DS1).
- String relationship The predicate to match. A null value matches all predicates.
Returns:
...
- _RelationshipTuple\[\]_\*\* _String subject_ \ - The subject of the relation. Either a Fedora object URI (eg info:fedora/demo:333) or a datastream URI (eg info:fedora/demo:333/DS1).
- String predicate - The predicate relating the subject and the object. Includes the namespace of the relation.
- String object - The URI of the object (target) of the relation
- boolean isLiteral - If true, the subject should be read as a literal value, not a URI
- String datatype - If the subject is a literal, the datatype to parse the value as. Optional.
...
Creates a new digital object in the repository. If the XML document does not specify the PID 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.
Parameters:
_byte\[\] objectXML_ The digital object in an XML submission format.Wiki Markup - String format The XML format of objectXML, one of "info:fedora/fedora-system:FOXML-1.1", "info:fedora/fedora-system:FOXML-1.0", "info:fedora/fedora-system:METSFedoraExt-1.1", "info:fedora/fedora-system:METSFedoraExt-1.0", "info:fedora/fedora-system:ATOM-1.1", or "info:fedora/fedora-system:ATOMZip-1.1".
- String logMessage A log message.
...
- Validation The validation datastructure
- String pid The pid of the object
- Boolean valid true if the object was valid
- Calendar asOfDateTime equals the asOfDateTime that was given as a paramenter
_String\[\] contentModels_ The content models of the objectWiki Markup Wiki Markup - _String\[\] objectProblems_ List of problems with the object itself
_Wiki Markup - DatastreamProblem\[\] datastreamProblems_ list of datastream problems
- String datastreamID The datastream ID
_String\[\] problem_ List of problems with this datastreamWiki Markup
WSDL
Anchor | ||||
---|---|---|---|---|
|
When running your own Fedora server, the API-M WSDL is available at /wsdl?api=API-M.
...
Warning | ||
---|---|---|
| ||
The Apache Axis library also automatically provides an INCORRECT WSDL DOCUMENT at /fedora/services/management?wsdl. Please DO NOT USE this; it is automatically generated and will result in unexpected behavior for your clients. The recommended URL, /fedora/wsdl?api=API-M produces a copy of the API-M WSDL exactly as it was intended. |
Include Page | ||||
---|---|---|---|---|
|