Webhob REST API Builds

From Yocto Project
Revision as of 09:19, 19 July 2013 by Ciprian Pratia (talk | contribs) (This contract describes the way lists of builds or single builds are supplied to the interface.)
Jump to navigationJump to search


Endpoints

Nr. Method Endpoint Body Description Comments
1 GET /builds JSON Returns page size limited and search criteria filtered amount of builds from the data base -
2 GET /builds_count JSON Returns the total amount of builds from the data base -
3 GET /builds/{id} JSON Returns single build from the data base according to it's id -

Parameters

Affected Endpoint Name Type Description Comments
1 limit number The amout of builds to be displayed in one page -
1 offset number Represents the position of the first record in the page -
1 filter string Consists of a string used to filter results -
3 id number Path parameter that passes the build id -

Responses

Endpoint 1 ( /builds )

The information retrieved from this endpoint is actualy a list of same tructure objects. The following table describes a generic element of the list.

Name Type Dimension Required Default value(s) Description Comments
[Object Root] Object - YES - The object root (will not be literaly be used in the coding). Used only here to describe the container for the actual properties. -
[Object Root].outcome boolean - YES - Signals successful or failed build -
[Object Root].target string - YES - - -