Webhob REST API Builds: Difference between revisions

From Yocto Project
Jump to navigationJump to search
No edit summary
No edit summary
Line 41: Line 41:
| [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] || 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].<span color="#006600">outcome</span> || number || 2 || YES || - || Signals successful or failed build || -
| [Object Root].<span style="color:#006600">outcome</span> || number || 2 || YES || - || Signals successful or failed build || -
|-
|-
| [Object Root].<span color="#006600">target</span> || string || - || YES || - || - || -
| [Object Root].<span style="color:#006600">target</span> || string || - || YES || - || - || -
|-
|-
| [Object Root].<span color="#006600">machine</span> || string array || - || YES || - || - || -
| [Object Root].<span style="color:#006600">machine</span> || string array || - || YES || - || - || -
|-
|-
| [Object Root].<span color="#006600">startedOn</span> || number representation of date || - || YES || - ||  Marks the moment the process is started || -
| [Object Root].<span style="color:#006600">startedOn</span> || number representation of date || - || YES || - ||  Marks the moment the process is started || -
|-
|-
| [Object Root].<span color="#006600">completedOn</span> || number representation of date || - || YES || - || Marks the moment the process is completed || -
| [Object Root].<span style="color:#006600">completedOn</span> || number representation of date || - || YES || - || Marks the moment the process is completed || -
|-
|-
| [Object Root].<span color="#006600">errors</span> || number || - || YES || - || Number of errors || -
| [Object Root].<span style="color:#006600">errors</span> || number || - || YES || - || Number of errors || -
|-
|-
| [Object Root].<span color="#006600">warnings</span> || number || - || YES || - || Number of warnings || -
| [Object Root].<span style="color:#006600">warnings</span> || number || - || YES || - || Number of warnings || -
|-
|-
| [Object Root].<span color="#006600">log</span> || string || - || YES || - || Path to log file || -
| [Object Root].<span style="color:#006600">log</span> || string || - || YES || - || Path to log file || -
|-
|-
| [Object Root].<span color="#006600">output</span> || string array || - || YES || - || Output package types || -
| [Object Root].<span style="color:#006600">output</span> || string array || - || YES || - || Output package types || -
|}
|}

Revision as of 09:39, 19 July 2013


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 number 2 YES - Signals successful or failed build -
[Object Root].target string - YES - - -
[Object Root].machine string array - YES - - -
[Object Root].startedOn number representation of date - YES - Marks the moment the process is started -
[Object Root].completedOn number representation of date - YES - Marks the moment the process is completed -
[Object Root].errors number - YES - Number of errors -
[Object Root].warnings number - YES - Number of warnings -
[Object Root].log string - YES - Path to log file -
[Object Root].output string array - YES - Output package types -