Use a string as an URI segment

>>> pp (text "foo")
"foo"

Note: with -XOverloadedStrings extension enabled it's possible to use string literals as segments of the Jenkins API method URL

>>> pp' "foo"
"foo"

Note: don't put / in the string literal unless you want it URL-encoded, use (-/-) instead

>>> pp' "foo/bar"
"foo%2Fbar"

Use an integer as an URI segment

>>> pp (int 4)
"4"

Combine two paths

>>> pp ("foo" -/- "bar" -/- "baz")
"foo/bar/baz"

Make a key-value pair

>>> pp ("foo" -=- "bar")
"foo=bar"

Create the union of two queries

>>> pp ("foo" -=- "bar" -&- "baz")
"foo=bar&baz"

Take a list of key-value pairs and render them as a query

>>> pp (query [("foo", Nothing), ("bar", Just "baz"), ("quux", Nothing)])
"foo&bar=baz&quux"

>>> pp (query [])
""

Put path and query together

>>> pp ("qux" -/- "quux" -?- "foo" -=- "bar" -&- "baz")
"qux/quux?foo=bar&baz"

Formatters know how to append the "api/$format" string to the method URL

Append the JSON formatting request to the method URL

>>> format json "foo"
"foo/api/json"

Append the XML formatting request to the method URL

>>> format xml "foo"
"foo/api/xml"

Append the Python formatting request to the method URL

>>> format python "foo"
"foo/api/python"

The formatter that does exactly nothing

>>> format plain "foo"
"foo"

Job data

>>> format json (job "name")
"job/name/api/json"

>>> pp (job "name" -/- "config.xml")
"job/name/config.xml"

Job build data

>>> format json (build "name" 4)
"job/name/4/api/json"

View data

>>> format xml (view "name")
"view/name/api/xml"

Build queue data

>>> format python queue
"queue/api/python"

Server statistics

>>> format xml overallLoad
"overallLoad/api/xml"

Nodes data

>>> format python computer
"computer/api/python"

Jenkins RESTFul API method encoding

Method types

Response formats