Ciprian Pratia: Created page with "Category:REST API Contracts === Endpoints === {| class="wikitable" |- ! Method !! Endpoint !! Body !! Description !! Comments |- | GET || /builds || JSON || Returns page si..."

2013-07-25T14:01:46Z

Created page with "Category:REST API Contracts === Endpoints === {| class="wikitable" |- ! Method !! Endpoint !! Body !! Description !! Comments |- | GET || /builds || JSON || Returns page si..."

New page

[[Category:REST API Contracts]]

=== Endpoints ===

{| class="wikitable"
|-
! Method !! Endpoint !! Body !! Description !! Comments
|-
| GET || /builds || JSON || Returns page size limited and search criteria filtered amount of builds from the data base || -
|}

=== Parameters ===

{| class="wikitable"
|-
! 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
|-
| search || string || Search string for all fields || -
|-
| filter || string || Consists of a string used to filter results || The general form: "<FIELD>:<VALUE>".
|-
| orderby || string || the name of the field that determens the soring of the resuls. || "<FIELD>:<ORDER_DIRECTION>"
|}

=== Response ===

{| class="wikitable"
|-
! Name !! Type !! Dimension !! Required !! Default value(s) !! Description !! Comments
|-
| [Object Root] || object || - || YES || - || - || -
|-
| [Object Root].count || number || - || YES || - || Total amount of builds to be displayed (according to filter parameter) || -
|-
| [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[].pk || number || - || YES || - || - || -
|-
| [Object Root].list[].model || string || - || YES || - || - || -
|-
| [Object Root].list[].fields || object || - || YES || - || - || -
|-
| [Object Root].list[].fields.outcome || number || 2 || YES || - || Signals successful or failed build || 0 - the build has failed, 1 - successful build
|-
| [Object Root].list[].fields.target || string || - || YES || - || The name of the build target(s) || -
|-
| [Object Root].list[].fields.machine || string array || - || YES || - || The selected hardware || -
|-
| [Object Root].list[].fields.started_on || number representation of date || - || YES || - || Marks the moment the process is started || -
|-
| [Object Root].list[].fields.completed_on || number representation of date || - || YES || - || Marks the moment the process is completed || -
|-
| [Object Root].list[].fields.errors_no || number || - || YES || - || Number of errors thrown by the build || -
|-
| [Object Root].list[].fields.warnings_no || number || - || YES || - || Number of warnings thrown by the build || -
|-
| [Object Root].list[].fields.cooker_log_path || string || - || YES || - || Path to log file || -
|-
| [Object Root].list[].fields.image_fstypes || string array || - || YES || - || The extensions of the root file systems produced by the build || -
|}

Webhob REST API Packages - Revision history

Ciprian Pratia: Created page with "Category:REST API Contracts === Endpoints === {| class="wikitable" |- ! Method !! Endpoint !! Body !! Description !! Comments |- | GET || /builds || JSON || Returns page si..."