Hudson - Core REST API

Data: build

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

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 build

Example XML

<?xml version="1.0" encoding="UTF-8"?> <build:build xmlns:build="http://hudson-ci.org/xsd/hudson/2.1.0/rest/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> </build:build>

Example JSON

{ "type" : "...", "url" : "...", "id" : "...", "number" : ..., "description" : "...", "projectName" : "...", "duration" : ..., "timeStamp" : ..., "result" : { }, "state" : { }, "kept" : false, "causes" : [ { "type" : "...", "description" : "..." }, ... ], "participants" : [ "...", ... ], "culprits" : [ "...", ... ], "changesAvailable" : false, "testsAvailable" : false }

Element builds

Example XML

<?xml version="1.0" encoding="UTF-8"?> <build:builds xmlns:build="http://hudson-ci.org/xsd/hudson/2.1.0/rest/build"> <build> <!--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> </build> <build> <!--(another 'build' type)--> </build> <!--...more "build" elements...--> </build:builds>

Example JSON

{ "build" : [ { "type" : "...", "url" : "...", "id" : "...", "number" : ..., "description" : "...", "projectName" : "...", "duration" : ..., "timeStamp" : ..., "result" : { }, "state" : { }, "kept" : false, "causes" : [ { "type" : "...", "description" : "..." }, ... ], "participants" : [ "...", ... ], "culprits" : [ "...", ... ], "changesAvailable" : false, "testsAvailable" : false }, ... ] }

Element changes

Example XML

<?xml version="1.0" encoding="UTF-8"?> <build:changes xmlns:build="http://hudson-ci.org/xsd/hudson/2.1.0/rest/build"> <kind> <!--content of type 'string'--> ... </kind> <entry> <!--content of type 'changeEntry'--> <message> <!--content of type 'string'--> ... </message> <author> <!--content of type 'user'--> <id> <!--content of type 'string'--> ... </id> <fullName> <!--content of type 'string'--> ... </fullName> <description> <!--content of type 'string'--> ... </description> </author> <path> <!--content of type 'string'--> ... </path> <path> <!--(another 'string' type)--> </path> <!--...more "path" elements...--> <file> <!--content of type 'changeFile'--> <path> <!--content of type 'string'--> ... </path> <type> <!--content of type 'changeType'--> ... </type> </file> <file> <!--(another 'changeFile' type)--> </file> <!--...more "file" elements...--> </entry> <entry> <!--(another 'changeEntry' type)--> </entry> <!--...more "entry" elements...--> </build:changes>

Example JSON

{ "kind" : "...", "entry" : [ { "message" : "...", "author" : { "id" : "...", "fullName" : "...", "description" : "..." }, "path" : [ "...", ... ], "file" : [ { "path" : "...", "type" : { } }, ... ] }, ... ] }

Element console

Example XML

<?xml version="1.0" encoding="UTF-8"?> <build:console xmlns:build="http://hudson-ci.org/xsd/hudson/2.1.0/rest/build"> <exists> <!--content of type 'boolean'--> ... </exists> <length> <!--content of type 'long'--> ... </length> <lastModified> <!--content of type 'long'--> ... </lastModified> </build:console>

Example JSON

{ "exists" : false, "length" : ..., "lastModified" : ... }

Element tests

Example XML

<?xml version="1.0" encoding="UTF-8"?> <build:tests xmlns:build="http://hudson-ci.org/xsd/hudson/2.1.0/rest/build"> <total> <!--content of type 'int'--> ... </total> <failed> <!--content of type 'int'--> ... </failed> <skipped> <!--content of type 'int'--> ... </skipped> <suite> <!--content of type 'testSuite'--> <name> <!--content of type 'string'--> ... </name> <timeStamp> <!--content of type 'string'--> ... </timeStamp> <duration> <!--content of type 'float'--> ... </duration> <case> <!--content of type 'testCase'--> <name> <!--content of type 'string'--> ... </name> <className> <!--content of type 'string'--> ... </className> <duration> <!--content of type 'float'--> ... </duration> <errorStackTrace> <!--content of type 'string'--> ... </errorStackTrace> <errorDetails> <!--content of type 'string'--> ... </errorDetails> <status> <!--content of type 'testCaseStatus'--> ... </status> <age> <!--content of type 'int'--> ... </age> </case> <case> <!--(another 'testCase' type)--> </case> <!--...more "case" elements...--> </suite> <suite> <!--(another 'testSuite' type)--> </suite> <!--...more "suite" elements...--> </build:tests>

Example JSON

{ "total" : ..., "failed" : ..., "skipped" : ..., "suite" : [ { "name" : "...", "timeStamp" : "...", "duration" : ..., "case" : [ { "name" : "...", "className" : "...", "duration" : ..., "errorStackTrace" : "...", "errorDetails" : "...", "status" : { }, "age" : ... }, ... ] }, ... ] }

Type build

Child Elements

name (type) min/max
occurs
description
type (string) 1/1 (no documentation provided)
url (string) 1/1 (no documentation provided)
id (string) 1/1 (no documentation provided)
number (int) 1/1 (no documentation provided)
description (string) 0/1 (no documentation provided)
projectName (string) 1/1 (no documentation provided)
duration (long) 0/1 (no documentation provided)
timeStamp (long) 1/1 (no documentation provided)
result (buildResult) 0/1 (no documentation provided)
state (buildState) 0/1 (no documentation provided)
kept (boolean) 1/1 (no documentation provided)
causes (cause) 0/unbounded (no documentation provided)
participants (string) 0/unbounded (no documentation provided)
culprits (string) 0/unbounded (no documentation provided)
changesAvailable (boolean) 1/1 (no documentation provided)
testsAvailable (boolean) 1/1 (no documentation provided)

Type buildResult

Possible Values

value description
SUCCESS
FAILURE
UNSTABLE
NOT_BUILT
ABORTED

Type builds

Child Elements

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

Type buildState

Possible Values

value description
NOT_STARTED
BUILDING
POST_PRODUCTION
COMPLETED

Type cause

Child Elements

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

Type changeEntry

Child Elements

name (type) min/max
occurs
description
message (string) 1/1 (no documentation provided)
author (user) 1/1 (no documentation provided)
path (string) 1/unbounded (no documentation provided)
file (changeFile) 1/unbounded (no documentation provided)

Type changeFile

Child Elements

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

Type changes

Child Elements

name (type) min/max
occurs
description
kind (string) 1/1 (no documentation provided)
entry (changeEntry) 1/unbounded (no documentation provided)

Type changeType

Possible Values

value description
ADD
EDIT
DELETE

Type console

Child Elements

name (type) min/max
occurs
description
exists (boolean) 1/1 (no documentation provided)
length (long) 0/1 (no documentation provided)
lastModified (long) 0/1 (no documentation provided)

Type testCase

Child Elements

name (type) min/max
occurs
description
name (string) 1/1 (no documentation provided)
className (string) 1/1 (no documentation provided)
duration (float) 1/1 (no documentation provided)
errorStackTrace (string) 1/1 (no documentation provided)
errorDetails (string) 1/1 (no documentation provided)
status (testCaseStatus) 1/1 (no documentation provided)
age (int) 1/1 (no documentation provided)

Type testCaseStatus

Possible Values

value description
PASSED
SKIPPED
FAILED
FIXED
REGRESSION

Type tests

Child Elements

name (type) min/max
occurs
description
total (int) 1/1 (no documentation provided)
failed (int) 1/1 (no documentation provided)
skipped (int) 1/1 (no documentation provided)
suite (testSuite) 1/unbounded (no documentation provided)

Type testSuite

Child Elements

name (type) min/max
occurs
description
name (string) 1/1 (no documentation provided)
timeStamp (string) 0/1 (no documentation provided)
duration (float) 1/1 (no documentation provided)
case (testCase) 1/unbounded (no documentation provided)

Type userCause

Child Elements

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