hudson.model.Api.index.jelly Maven / Gradle / Ivy
Show all versions of hudson-core Show documentation
Remote API
(Read more in the Hudson Wiki.)
Many objects of Hudson provides the remote access API. They are available
at http://your_server/.../api/ where "..." portion is the object for
which you'd like to access.
- XML API
-
Access data exposed in HTML as XML for machine consumption.
Schema is also available.
You can also specify optional XPath to control the fragment you'd like to obtain.
For example, ../api/xml?xpath=/*/*[0]. If the XPath only matches a text node,
the result will be sent with text/plain MIME type to simplify
further processing.
For XPath that matches multiple nodes, you need to also specify the "wrapper" query parameter
to specify the name of the root XML element to be create so that the resulting XML becomes well-formed.
Similarly exclude query parameter can be used to exclude nodes
that match the given XPath from the result. This is useful for
trimming down the amount of data you fetch. This query parameter can be specified
multiple times.
See also the
online help page which talks about the tree query parameter which may be a
better choice than XPath for filtering the output
- JSON API
-
Access the same data as JSON for JavaScript-based access. Supports
JSONP through
the optional jsonp=callbackname query parameter.
Controlling the amount of data you fetch
Using the API you can control the amount of, and filter the data returned using the depth
and tree query parameters. See the linked help page for more information and examples.
Online Help for More Information
For more information about remote API in Hudson, see the
online help page.