Additional optional properties for MediaType as
described by IANA.
The property name for this entry.
Value drawn from the value space of IANA Media Types (
http://www.iana.org/assignments/media-types/media-types.xhtml ). When
specified, indicates the IANA Media Type (aka MIME-Type) of the object.
The name attribute MUST include the media type and subtype
(e.g. text/csv). The media type value is not case sensitive.
Any required media type parameters must be provided, and
optional parameters may be specified. There are no explicit constraints
on the name of media-type properties or their values, however they
SHOULD conform to media type optional and required parameters as
specified in the respective media type RFC.
Media-type parameter(s) as specified by the
respective RFC for the media-type.
The value of the media-type specified as a
required 'name' attribute of the mediaType element.
System metadata in DataONE APIs version 2.0 extends
the :class:`types.SystemMetadata` definition of version 1.x by adding
:term:`seriesId`, :term:`mediaType`, and :term:`fileName` elements. Each
of these are optional, so Version 1.x System Metadata is compatible with
Version 2.x, though not vice-versa.
The :term:`seriesId` is an optional, unique
Unicode string that identifies an object revision chain. A
seriesId will resolve to the latest version of an object. A seriesId can not appear in any other revision chain.
The values used for seriesId must be unique
within DataONE and cannot be the same as the :term:`primary
identifier` of an object.
The same encoding rules used for identifier
values apply to seriesId values.
When specified, indicates the IANA Media
Type (aka MIME-Type) of the object. When specified, this
value overrides the default value specified in the version
2.0 ObjectFormat structure. The value should include the
media type and subtype (e.g. text/csv). The mediaType value
is not case sensitive.
The purpose of this value is to provide
more detailed information about the specific media type
of the associated object than may be available through
the associated ObjectFormat.
When specified, the mediaType value here
overrides the value recorded in the referenced
:class:`ObjectFormat`.
This value SHOULD be set by the content
creator. It MAY be set by any receiving agent if the value
is not already set, the value in the ObjectFormat is less
specific, and a correct value is specified elsewhere such
as by a HTTP Content-Type parameter.
This value MAY be changed to correct an
erroneous entry.
Optional though recommended value providing
a suggested file name for the object. Values should
conform to cross platform file naming conventions.
This value SHOULD be set by the content
creator.
This value MAY be set by any receiving agent
Changing the value is discouraged once set, unless by the
authoritative Member Node of content owner.
A list of :class:`v2_0.Types.Node` entries returned by
:func:`CNCore.listNodes()`.
NodeList is described in :mod:`NodeList`.
Extends the Version 1.x :class:`Types.Node` by adding
an optional unbounded parameter entry providing additional simple
metadata relevant to a Node.
Allows additional attributes be added to the
Node document as needed.
Additional Property elements can be included to
describe the Node in more detail. Some properties will come from
controlled vocabularies indicated by the type attribute, while
others will be free-form key value pairs.
The property key for this entry. Should be
unique within the Node element.
The optional type for the property. Can be
used to indicate if a controlled vocabulary is used for the
property key to better facilitate machine interpretation.
Extends Version 1.x :class:`Types.ObjectFormat` by
adding :term:`mediaType` and :term:`extension` elements.
The IANA Media Type for this object format.
Suggested file name extension to be used
when serializing this type of object to a file. The value
should not include the period (.).
Extends :class:`Types.ObjectFormatList` to provide a
list of :class:`v2_0.Types.ObjectFormat`.
Extends :class:`Types.Log` to represent a collection of
:class:`v2_0.Types.LogEntry` elements, used to transfer log information
between DataONE components.
Extends :class:`Types.LogEntry` by relaxing the value
space for the *event* element.
A unique identifier for this log entry. The
identifier should be unique for a particular node; This is not drawn
from the same value space as other identifiers in DataONE, and so is
not subject to the same restrictions.
The :term:`identifier` of the object that was the
target of the operation which generated this log entry.
The IP address, as reported by the service receiving
the request, of the request origin.
The user agent of the client making the request, as
reported in the User-Agent HTTP header.
The :term:`Subject` used for making the request.
This may be the DataONE :term:`public` user if the request is not
authenticated, otherwise it will be the *subject* of the certificate
used for authenticating the request.
A non-empty string indicating the type of event
logged. A value from the :class:`Types.Event` enumeration is
recommended though no longer required for Version 2.x.
A :class:`Types.DateTime` time stamp indicating when
the event triggering the log message ocurred. Note that all time
stamps in DataONE are in UTC.
The unique identifier for the node where the log
message was generated.
A list of options that indicate the possible values for
a DataONE service. Each option that can be validly sent to a service is
listed, providing the specific key that should be used when interacting
with the service, as well as a description of that key that allows API
users to understand the usage of the key. For example, an OptionList
might contain a list of themes that can be used with the MNView.view
service, or for other services that have a configurable but controlled
set of parameters.
The key to be used within an API call to a DataONE
service, including a description of the key and its impact on the
service. For example, a key 'default' can be provided as the theme for
the MNView.view service. Keys must not contain characters that will
need to be URL escaped.
A value that can be used with a DataONE service. Key
values must not contain any characters that need to be URL escaped, and
should be short and informative.
The description of an option, indicating its intended
use and impact on a DataONE service invocation.