A container for a collection of resources.
A container for a collection of resources.
If the element is present, it must have either a @value, an @id, or extensions
A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
Indicates the purpose of this bundle - how it is intended to be used.
The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
A series of links that provide context to this bundle.
An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Digital Signature - base64 encoded. XML-DSig or a JWS.
Captures issues and warnings that relate to the construction of the Bundle and the content within it.
A container for a collection of resources.
A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
The reference details for the link.
A container for a collection of resources.
A series of links that provide context to this entry.
The Absolute URL for the resource. Except for transactions and batches, each entry in a Bundle must have a fullUrl. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. Even when not required, fullUrl MAY be set to a urn:uuid to allow referencing entries in a transaction. The fullUrl can be an arbitrary URI and is not limited to urn:uuid, urn:oid, http, and https. The fullUrl element SHALL have a value except when:
* invoking a create
* invoking or responding to an operation where the body is not a single identified resource
* invoking or returning the results of a search or history operation.
The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type. This is allowed to be a Parameters resource if and only if it is referenced by something else within the Bundle that provides context/meaning.
Information about the search process that lead to the creation of this entry.
Additional information about how this entry should be processed as part of a transaction or batch. For history, it shows how the entry was processed to create the version contained in the entry.
Indicates the results of processing the corresponding 'request' entry in the batch or transaction being responded to or what the results of an operation where when returning history.
A container for a collection of resources.
Why this entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
When searching, the server's search ranking score for the entry.
A container for a collection of resources.
In a transaction or batch, this is the HTTP action to be executed for this entry. In a history bundle, this indicates the HTTP action that occurred.
The URL for this entry, relative to the root (the address to which the request is posted).
If the ETag values match, return a 304 Not Modified status. See the API documentation for ["Conditional Read"](http.html#cread).
Only perform the operation if the last updated date matches. See the API documentation for ["Conditional Read"](http.html#cread).
Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency).
Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?").
A container for a collection of resources.
The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
The location header created by processing this operation, populated if the operation returns a location.
The Etag for the resource, if the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
The date/time that the resource was modified on the server.
An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
GET
HEAD
POST
PUT
DELETE
PATCH
If the element is present, it must have either a @value, an @id, or extensions
Document
Message
Transaction
Transaction Response
Batch
Batch Response
History List
Search Results
Collection
Subscription Notification
If the element is present, it must have either a @value, an @id, or extensions
Match
Include
Outcome
If the element is present, it must have either a @value, an @id, or extensions
Refers to a resource that is the subject of the link's context.
Asserts that the link target provides an access control description for the link context.
Refers to a substitute for this context
Used to reference alternative content that uses the AMP profile of the HTML format.
Refers to an appendix.
Refers to an icon for the context. Synonym for icon.
Refers to a launch screen for the context.
Refers to a collection of records, documents, or other
materials of historical interest.
Refers to the context's author.
Identifies the entity that blocks access to a resource
following receipt of a legal demand.
Gives a permanent link to use for bookmarking purposes.
Designates the preferred version of a resource (the IRI and its contents).
Refers to a chapter in a collection of resources.
Indicates that the link target is preferred over the link context for the purpose of permanent citation.
The target IRI points to a resource which represents the collection resource for the context IRI.
Refers to a table of contents.
The document linked to was later converted to the
document that contains this link relation. For example, an RFC can
have a link to the Internet-Draft that became the RFC; in that case,
the link relation would be "convertedFrom".
Refers to a copyright statement that applies to the
link's context.
The target IRI points to a resource where a submission form can be obtained.
Refers to a resource containing the most recent
item(s) in a collection of resources.
Refers to a resource providing information about the
link's context.
The relationship A 'describes' B asserts that
resource A provides a description of resource B. There are no
constraints on the format or representation of either A or B,
neither are there any further constraints on either resource.
Refers to a list of patent disclosures made with respect to
material for which 'disclosure' relation is specified.
Used to indicate an origin that will be used to fetch required
resources for the link context, and that the user agent ought to resolve
as early as possible.
Refers to a resource whose available representations
are byte-for-byte identical with the corresponding representations of
the context IRI.
Refers to a resource that can be used to edit the
link's context.
The target IRI points to a resource where a submission form for
editing associated resource can be obtained.
Refers to a resource that can be used to edit media
associated with the link's context.
Identifies a related resource that is potentially
large and might require special handling.
Refers to a resource that is not part of the same site as the current context.
An IRI that refers to the furthest preceding resource
in a series of resources.
Refers to a glossary of terms.
Refers to context-sensitive help.
Refers to a resource hosted by the server indicated by
the link context.
Refers to a hub that enables registration for
notification of updates to the context.
Refers to an icon representing the link's context.
Refers to an index.
refers to a resource associated with a time interval that ends before the beginning of the time interval associated with the context resource
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
refers to a resource associated with a time interval that begins after the end of the time interval associated with the context resource, or ends before the beginning of the time interval associated with the context resource
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
refers to a resource associated with a time interval that begins after the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and whose end coincides with the end of the time interval associated with the context resource
refers to a resource associated with a time interval that begins before or is coincident with the beginning of the time interval associated with the context resource, and ends after or is coincident with the end of the time interval associated with the context resource
refers to a resource associated with a time interval whose beginning coincides with the end of the time interval associated with the context resource
refers to a resource associated with a time interval whose end coincides with the beginning of the time interval associated with the context resource
refers to a resource associated with a time interval that begins before the beginning of the time interval associated with the context resource, and ends after the beginning of the time interval associated with the context resource
refers to a resource associated with a time interval that begins before the end of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends before the end of the time interval associated with the context resource
refers to a resource associated with a time interval whose beginning coincides with the beginning of the time interval associated with the context resource, and ends after the end of the time interval associated with the context resource
The target IRI points to a resource that is a member of the collection represented by the context IRI.
An IRI that refers to the furthest following resource
in a series of resources.
Points to a resource containing the latest (e.g.,
current) version of the context.
Refers to a license associated with this context.
The link target of a link with the "linkset" relation
type provides a set of links, including links in which the link
context of the link participates.
Refers to further information about the link's context,
expressed as a LRDD ("Link-based Resource Descriptor Document")
resource. See for information about
processing this relation type in host-meta documents. When used
elsewhere, it refers to additional links and other metadata.
Multiple instances indicate additional LRDD resources. LRDD
resources MUST have an "application/xrd+xml" representation, and
MAY have others.
Links to a manifest file for the context.
Refers to a mask that can be applied to the icon for the context.
Refers to a feed of personalised media recommendations relevant to the link context.
The Target IRI points to a Memento, a fixed resource that will not change state anymore.
Links to the context's Micropub endpoint.
Refers to a module that the user agent is to preemptively fetch and store for use in the current context.
Refers to a resource that can be used to monitor changes in an HTTP resource.
Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.
Indicates that the link's context is a part of a series, and
that the next in the series is the link target.
Refers to the immediately following archive resource.
Indicates that the context’s original author or publisher does not endorse the link target.
Indicates that any newly created top-level browsing context which results from following the link will not be an auxiliary browsing context.
Indicates that no referrer information is to be leaked when following the link.
Indicates that any newly created top-level browsing context which results from following the link will be an auxiliary browsing context.
Refers to an OpenID Authentication server on which the context relies for an assertion that the end user controls an Identifier.
Refers to a resource which accepts OpenID Authentication protocol messages for the context.
The Target IRI points to an Original Resource.
Refers to a P3P privacy policy for the context.
Indicates a resource where payment is accepted.
Gives the address of the pingback resource for the link context.
Used to indicate an origin that will be used to fetch required
resources for the link context. Initiating an early connection, which
includes the DNS lookup, TCP handshake, and optional TLS negotiation,
allows the user agent to mask the high latency costs of establishing a
connection.
Points to a resource containing the predecessor
version in the version history.
The prefetch link relation type is used to identify a resource
that might be required by the next navigation from the link context, and
that the user agent ought to fetch, such that the user agent can deliver a
faster response once the resource is requested in the future.
Refers to a resource that should be loaded early in the
processing of the link's context, without blocking rendering.
Used to identify a resource that might be required by the next
navigation from the link context, and that the user agent ought to fetch
and execute, such that the user agent can deliver a faster response once
the resource is requested in the future.
Indicates that the link's context is a part of a series, and
that the previous in the series is the link target.
Refers to a resource that provides a preview of the link's context.
Refers to the previous resource in an ordered series
of resources. Synonym for "prev".
Refers to the immediately preceding archive resource.
Refers to a privacy policy associated with the link's context.
Identifying that a resource representation conforms
to a certain profile, without affecting the non-profile semantics
of the resource representation.
Links to a publication manifest. A manifest represents
structured information about a publication, such as informative metadata,
a list of resources, and a default reading order.
Identifies a related resource.
Identifies the root of RESTCONF API as configured on this HTTP server.
The "restconf" relation defines the root of the API defined in RFC8040.
Subsequent revisions of RESTCONF will use alternate relation values to support
protocol versioning.
Identifies a resource that is a reply to the context
of the link.
The resource identified by the link target provides an input value to an
instance of a rule, where the resource which represents the rule instance is
identified by the link context.
Refers to a resource that can be used to search through
the link's context and related resources.
Refers to a section in a collection of resources.
Conveys an identifier for the link's context.
Indicates a URI that can be used to retrieve a
service document.
Identifies service description for the context that
is primarily intended for consumption by machines.
Identifies service documentation for the context that
is primarily intended for human consumption.
Identifies general metadata for the context that is
primarily intended for consumption by machines.
Refers to a resource that is within a context that is
sponsored (such as advertising or another compensation agreement).
Refers to the first resource in a collection of
resources.
Identifies a resource that represents the context's
status.
Refers to a stylesheet.
Refers to a resource serving as a subsection in a
collection of resources.
Points to a resource containing the successor version
in the version history.
Identifies a resource that provides information about
the context's retirement policy.
Gives a tag (identified by the given address) that applies to
the current document.
Refers to the terms of service associated with the link's context.
The Target IRI points to a TimeGate for an Original Resource.
The Target IRI points to a TimeMap for an Original Resource.
Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.
Refers to a resource that is within a context that is User Generated Content.
Refers to a parent document in a hierarchy of
documents.
Points to a resource containing the version history
for the context.
Identifies a resource that is the source of the
information in the link's context.
Identifies a target URI that supports the Webmention protocol.
This allows clients that mention a resource in some form of publishing process
to contact that endpoint and inform it that this resource has been mentioned.
Points to a working copy for this resource.
Points to the versioned resource from which this
working copy was obtained.
If the element is present, it must have either a @value, an @id, or extensions