Webhob REST API Builds

From Yocto Project
Revision as of 11:30, 22 July 2013 by Ddalex (talk | contribs) (moved Builds to Webhob REST API Builds: Avoid concept collision with a Build in Yocto normal terminology.)
Jump to navigationJump to search


Endpoints

Method Endpoint Body Description Comments
GET /builds JSON Returns page size limited and search criteria filtered amount of builds from the data base -

Parameters

Name Type Description Comments
limit number The amout of builds to be displayed in one page -
offset number Represents the position of the first record in the page If limit is 1, end point will target the findOne functionality and the offset will act as the actual build id
filter string Consists of a string used to filter results Generic parameter sent from front-end application.

Response

Name Type Dimension Required Default value(s) Description Comments
[Object Root] object - YES - - -
[Object Root].count number - YES - Total amount of builds -
[Object Root].list object array - YES - - To describe a generic object element of the array,
the refference to it's root is "list[]"
[Object Root].list[].outcome number 2 YES - Signals successful or failed build 0 - the build has failed,
1 - successful build
[Object Root].list[].target string - YES - The name of the build target(s) -
[Object Root].list[].machine string array - YES - The selected hardware -
[Object Root].list[].startedOn number representation of date - YES - Marks the moment the process is started -
[Object Root].list[].completedOn number representation of date - YES - Marks the moment the process is completed -
[Object Root].list[].errors number - YES - Number of errors thrown by the build -
[Object Root].list[].warnings number - YES - Number of warnings thrown by the build -
[Object Root].list[].log string - YES - Path to log file -
[Object Root].list[].output string array - YES - The extensions of the root file systems produced by the build -