Hudson - Core REST API

Data: common

  • Namespace: http://hudson-ci.org/xsd/hudson/2.1.0/rest/common

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element node

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:node xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <name> <!--content of type 'string'--> ... </name> <description> <!--content of type 'string'--> ... </description> <executors> <!--content of type 'int'--> ... </executors> <mode> <!--content of type 'nodeMode'--> ... </mode> </common:node>

Example JSON

{ "name" : "...", "description" : "...", "executors" : ..., "mode" : { } }

Element nodes

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:nodes xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <node> <!--content of type 'node'--> <name> <!--content of type 'string'--> ... </name> <description> <!--content of type 'string'--> ... </description> <executors> <!--content of type 'int'--> ... </executors> <mode> <!--content of type 'nodeMode'--> ... </mode> </node> <node> <!--(another 'node' type)--> </node> <!--...more "node" elements...--> </common:nodes>

Example JSON

{ "node" : [ { "name" : "...", "description" : "...", "executors" : ..., "mode" : { } }, ... ] }

Element permission

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:permission xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <id> <!--content of type 'string'--> ... </id> <impliedBy> <!--content of type 'permission'--> <!--(content not shown)--> </impliedBy> </common:permission>

Example JSON

{ "id" : "...", "impliedBy" : { "..." : ... } }

Element permissions

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:permissions xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <permission> <!--content of type 'permission'--> <id> <!--content of type 'string'--> ... </id> <impliedBy> <!--content of type 'permission'--> <!--(content not shown)--> </impliedBy> </permission> <permission> <!--(another 'permission' type)--> </permission> <!--...more "permission" elements...--> </common:permissions>

Example JSON

{ "permission" : [ { "id" : "...", "impliedBy" : { "..." : ... } }, ... ] }

Element status

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:status xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <url> <!--content of type 'string'--> ... </url> <version> <!--content of type 'string'--> ... </version> <initLevel> <!--content of type 'initLevel'--> ... </initLevel> <quietingDown> <!--content of type 'boolean'--> ... </quietingDown> <terminating> <!--content of type 'boolean'--> ... </terminating> <systemMessage> <!--content of type 'string'--> ... </systemMessage> <user> <!--content of type 'user'--> <id> <!--content of type 'string'--> ... </id> <fullName> <!--content of type 'string'--> ... </fullName> <description> <!--content of type 'string'--> ... </description> </user> </common:status>

Example JSON

{ "url" : "...", "version" : "...", "initLevel" : { }, "quietingDown" : false, "terminating" : false, "systemMessage" : "...", "user" : { "id" : "...", "fullName" : "...", "description" : "..." } }

Element user

Example XML

<?xml version="1.0" encoding="UTF-8"?> <common:user xmlns:common="http://hudson-ci.org/xsd/hudson/2.1.0/rest/common"> <id> <!--content of type 'string'--> ... </id> <fullName> <!--content of type 'string'--> ... </fullName> <description> <!--content of type 'string'--> ... </description> </common:user>

Example JSON

{ "id" : "...", "fullName" : "...", "description" : "..." }

Type initLevel

Possible Values

value description
STARTED
PLUGINS_LISTED
PLUGINS_PREPARED
PLUGINS_STARTED
JOB_LOADED
COMPLETED

Type node

Child Elements

name (type) min/max
occurs
description
name (string) 1/1 (no documentation provided)
description (string) 1/1 (no documentation provided)
executors (int) 1/1 (no documentation provided)
mode (nodeMode) 1/1 (no documentation provided)

Type nodeMode

Possible Values

value description
NORMAL
EXCLUSIVE

Type nodes

Child Elements

name (type) min/max
occurs
description
node (node) 0/unbounded (no documentation provided)

Type permission

Child Elements

name (type) min/max
occurs
description
id (string) 1/1 (no documentation provided)
impliedBy (permission) 0/1 (no documentation provided)

Type permissions

Child Elements

name (type) min/max
occurs
description
permission (permission) 0/unbounded (no documentation provided)

Type status

Child Elements

name (type) min/max
occurs
description
url (string) 1/1 (no documentation provided)
version (string) 1/1 (no documentation provided)
initLevel (initLevel) 1/1 (no documentation provided)
quietingDown (boolean) 1/1 (no documentation provided)
terminating (boolean) 1/1 (no documentation provided)
systemMessage (string) 0/1 (no documentation provided)
user (user) 0/1 (no documentation provided)

Type user

Child Elements

name (type) min/max
occurs
description
id (string) 1/1 (no documentation provided)
fullName (string) 1/1 (no documentation provided)
description (string) 1/1 (no documentation provided)