Hudson - Core REST API

Data: project

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

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 project

Example XML

<?xml version="1.0" encoding="UTF-8"?> <project:project xmlns:project="http://hudson-ci.org/xsd/hudson/2.1.0/rest/project"> <ref> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </ref> <type> <!--content of type 'string'--> ... </type> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> <name> <!--content of type 'string'--> ... </name> <title> <!--content of type 'string'--> ... </title> <description> <!--content of type 'string'--> ... </description> <enabled> <!--content of type 'boolean'--> ... </enabled> <configurable> <!--content of type 'boolean'--> ... </configurable> <concurrent> <!--content of type 'boolean'--> ... </concurrent> <queued> <!--content of type 'boolean'--> ... </queued> <lastBuild> <!--content of type 'build'--> <type> <!--content of type 'string'--> ... </type> <url> <!--content of type 'string'--> ... </url> <id> <!--content of type 'string'--> ... </id> <number> <!--content of type 'int'--> ... </number> <description> <!--content of type 'string'--> ... </description> <projectName> <!--content of type 'string'--> ... </projectName> <duration> <!--content of type 'long'--> ... </duration> <timeStamp> <!--content of type 'long'--> ... </timeStamp> <result> <!--content of type 'buildResult'--> ... </result> <state> <!--content of type 'buildState'--> ... </state> <kept> <!--content of type 'boolean'--> ... </kept> <causes> <!--content of type 'cause'--> <type> <!--content of type 'string'--> ... </type> <description> <!--content of type 'string'--> ... </description> </causes> <causes> <!--(another 'cause' type)--> </causes> <!--...more "causes" elements...--> <participants> <!--content of type 'string'--> ... </participants> <participants> <!--(another 'string' type)--> </participants> <!--...more "participants" elements...--> <culprits> <!--content of type 'string'--> ... </culprits> <culprits> <!--(another 'string' type)--> </culprits> <!--...more "culprits" elements...--> <changesAvailable> <!--content of type 'boolean'--> ... </changesAvailable> <testsAvailable> <!--content of type 'boolean'--> ... </testsAvailable> </lastBuild> <blocked> <!--content of type 'boolean'--> ... </blocked> <blockedReason> <!--content of type 'string'--> ... </blockedReason> <health> <!--content of type 'health'--> <score> <!--content of type 'int'--> ... </score> <description> <!--content of type 'string'--> ... </description> </health> <parent> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </parent> <descendant> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </descendant> <descendant> <!--(another 'projectReference' type)--> </descendant> <!--...more "descendant" elements...--> <upstream> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </upstream> <upstream> <!--(another 'projectReference' type)--> </upstream> <!--...more "upstream" elements...--> <downstream> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </downstream> <downstream> <!--(another 'projectReference' type)--> </downstream> <!--...more "downstream" elements...--> </project:project>

Example JSON

{ "ref" : { "id" : "..." }, "type" : "...", "id" : "...", "url" : "...", "name" : "...", "title" : "...", "description" : "...", "enabled" : false, "configurable" : false, "concurrent" : false, "queued" : false, "lastBuild" : { "type" : "...", "url" : "...", "id" : "...", "number" : ..., "description" : "...", "projectName" : "...", "duration" : ..., "timeStamp" : ..., "result" : { }, "state" : { }, "kept" : false, "causes" : [ { "type" : "...", "description" : "..." }, ... ], "participants" : [ "...", ... ], "culprits" : [ "...", ... ], "changesAvailable" : false, "testsAvailable" : false }, "blocked" : false, "blockedReason" : "...", "health" : { "score" : ..., "description" : "..." }, "parent" : { "id" : "..." }, "descendant" : [ { "id" : "..." }, ... ], "upstream" : [ { "id" : "..." }, ... ], "downstream" : [ { "id" : "..." }, ... ] }

Element projects

Example XML

<?xml version="1.0" encoding="UTF-8"?> <project:projects xmlns:project="http://hudson-ci.org/xsd/hudson/2.1.0/rest/project"> <project> <!--content of type 'project'--> <ref> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </ref> <type> <!--content of type 'string'--> ... </type> <id> <!--content of type 'string'--> ... </id> <url> <!--content of type 'string'--> ... </url> <name> <!--content of type 'string'--> ... </name> <title> <!--content of type 'string'--> ... </title> <description> <!--content of type 'string'--> ... </description> <enabled> <!--content of type 'boolean'--> ... </enabled> <configurable> <!--content of type 'boolean'--> ... </configurable> <concurrent> <!--content of type 'boolean'--> ... </concurrent> <queued> <!--content of type 'boolean'--> ... </queued> <lastBuild> <!--content of type 'build'--> <type> <!--content of type 'string'--> ... </type> <url> <!--content of type 'string'--> ... </url> <id> <!--content of type 'string'--> ... </id> <number> <!--content of type 'int'--> ... </number> <description> <!--content of type 'string'--> ... </description> <projectName> <!--content of type 'string'--> ... </projectName> <duration> <!--content of type 'long'--> ... </duration> <timeStamp> <!--content of type 'long'--> ... </timeStamp> <result> <!--content of type 'buildResult'--> ... </result> <state> <!--content of type 'buildState'--> ... </state> <kept> <!--content of type 'boolean'--> ... </kept> <causes> <!--content of type 'cause'--> <type> <!--content of type 'string'--> ... </type> <description> <!--content of type 'string'--> ... </description> </causes> <causes> <!--(another 'cause' type)--> </causes> <!--...more "causes" elements...--> <participants> <!--content of type 'string'--> ... </participants> <participants> <!--(another 'string' type)--> </participants> <!--...more "participants" elements...--> <culprits> <!--content of type 'string'--> ... </culprits> <culprits> <!--(another 'string' type)--> </culprits> <!--...more "culprits" elements...--> <changesAvailable> <!--content of type 'boolean'--> ... </changesAvailable> <testsAvailable> <!--content of type 'boolean'--> ... </testsAvailable> </lastBuild> <blocked> <!--content of type 'boolean'--> ... </blocked> <blockedReason> <!--content of type 'string'--> ... </blockedReason> <health> <!--content of type 'health'--> <score> <!--content of type 'int'--> ... </score> <description> <!--content of type 'string'--> ... </description> </health> <parent> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </parent> <descendant> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </descendant> <descendant> <!--(another 'projectReference' type)--> </descendant> <!--...more "descendant" elements...--> <upstream> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </upstream> <upstream> <!--(another 'projectReference' type)--> </upstream> <!--...more "upstream" elements...--> <downstream> <!--content of type 'projectReference'--> <id> <!--content of type 'string'--> ... </id> </downstream> <downstream> <!--(another 'projectReference' type)--> </downstream> <!--...more "downstream" elements...--> </project> <project> <!--(another 'project' type)--> </project> <!--...more "project" elements...--> </project:projects>

Example JSON

{ "project" : [ { "ref" : { "id" : "..." }, "type" : "...", "id" : "...", "url" : "...", "name" : "...", "title" : "...", "description" : "...", "enabled" : false, "configurable" : false, "concurrent" : false, "queued" : false, "lastBuild" : { "type" : "...", "url" : "...", "id" : "...", "number" : ..., "description" : "...", "projectName" : "...", "duration" : ..., "timeStamp" : ..., "result" : { }, "state" : { }, "kept" : false, "causes" : [ { "type" : "...", "description" : "..." }, ... ], "participants" : [ "...", ... ], "culprits" : [ "...", ... ], "changesAvailable" : false, "testsAvailable" : false }, "blocked" : false, "blockedReason" : "...", "health" : { "score" : ..., "description" : "..." }, "parent" : { "id" : "..." }, "descendant" : [ { "id" : "..." }, ... ], "upstream" : [ { "id" : "..." }, ... ], "downstream" : [ { "id" : "..." }, ... ] }, ... ] }

Type health

Child Elements

name (type) min/max
occurs
description
score (int) 1/1 (no documentation provided)
description (string) 1/1 (no documentation provided)

Type project

Child Elements

name (type) min/max
occurs
description
ref (projectReference) 1/1 (no documentation provided)
type (string) 1/1 (no documentation provided)
id (string) 1/1 (no documentation provided)
url (string) 1/1 (no documentation provided)
name (string) 1/1 (no documentation provided)
title (string) 1/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
enabled (boolean) 1/1 (no documentation provided)
configurable (boolean) 1/1 (no documentation provided)
concurrent (boolean) 1/1 (no documentation provided)
queued (boolean) 1/1 (no documentation provided)
lastBuild (build) 0/1 (no documentation provided)
blocked (boolean) 0/1 (no documentation provided)
blockedReason (string) 0/1 (no documentation provided)
health (health) 0/1 (no documentation provided)
parent (projectReference) 1/1 (no documentation provided)
descendant (projectReference) 1/unbounded (no documentation provided)
upstream (projectReference) 1/unbounded (no documentation provided)
downstream (projectReference) 1/unbounded (no documentation provided)

Type projectReference

Child Elements

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

Type projects

Child Elements

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