Webhob REST API Builds - Revision history

Ddalex at 16:28, 14 August 2013

2013-08-14T16:28:36Z

← Older revision		Revision as of 16:28, 14 August 2013
Line 1:		Line 1:
	~~{{subst:afd}}~~		Superceded by [[REST API Contracts]]

Ddalex at 16:28, 14 August 2013

2013-08-14T16:28:11Z

← Older revision	Revision as of 16:28, 14 August 2013
Line 1:	Line 1:
		{{subst:afd}}

Ddalex: Blanked the page

2013-08-14T16:26:45Z

Blanked the page

← Older revision		Revision as of 16:26, 14 August 2013
Line 1:		Line 1:
	~~[[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 \|\| The only argument is the string searched in the database.~~
	\|-
	~~\| 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].<span style="color:#006600">count</span> \|\| number \|\| - \|\| YES \|\| - \|\| Total amount of builds to be displayed (according to filter parameter) \|\| -~~
	\|-
	~~\| [Object Root].<span style="color:#006600">list</span> \|\| object array \|\| - \|\| YES \|\| - \|\| - \|\| To describe a generic object element of the array,<br /> the refference to it's root is "list[]"~~
	\|-
	~~\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -~~
	\|-
	~~\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> \|\| string \|\| - \|\| YES \|\| - \|\| - \|\| -~~
	\|-
	~~\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -~~
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> \|\| number \|\| 2 \|\| YES \|\| - \|\| Signals successful or failed build \|\| 0 - the build has failed,<br /> 1 - successful build
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">target</span> \|\| string \|\| - \|\| YES \|\| - \|\| The name of the build target(s) \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The selected hardware \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">started_on</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is started \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">completed_on</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is completed \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">errors_no</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of errors thrown by the build \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">warnings_no</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of warnings thrown by the build \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cooker_log_path</span> \|\| string \|\| - \|\| YES \|\| - \|\| Path to log file \|\| -
	\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">image_fstypes</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The extensions of the root file systems produced by the build \|\| -
	\|}

Calin Dragomir at 12:16, 26 July 2013

2013-07-26T12:16:21Z

← Older revision		Revision as of 12:16, 26 July 2013
Line 20:		Line 20:
	\| 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		\| 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 \|\| -		\| search \|\| string \|\| Search string for all fields \|\| The only argument is the string searched in the database.
	\|-		\|-
	\| filter \|\| string \|\| Consists of a string used to filter results \|\| The general form: "<FIELD>:<VALUE>".		\| filter \|\| string \|\| Consists of a string used to filter results \|\| The general form: "<FIELD>:<VALUE>".

Ciprian Pratia at 15:09, 23 July 2013

2013-07-23T15:09:21Z

← Older revision		Revision as of 15:09, 23 July 2013
Line 24:		Line 24:
	\| filter \|\| string \|\| Consists of a string used to filter results \|\| The general form: "<FIELD>:<VALUE>".		\| 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. \|\| -		\| orderby \|\| string \|\| the name of the field that determens the soring of the resuls. \|\| "<FIELD>:<ORDER_DIRECTION>"
	\|}		\|}

Calin Dragomir at 11:04, 23 July 2013

2013-07-23T11:04:47Z

← Older revision		Revision as of 11:04, 23 July 2013
Line 41:		Line 41:
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">~~string~~</span> \|\| ~~number~~ \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">model</span> \|\| string \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -

Calin Dragomir at 10:41, 23 July 2013

2013-07-23T10:41:05Z

← Older revision		Revision as of 10:41, 23 July 2013
Line 51:		Line 51:
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The selected hardware \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The selected hardware \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~startedOn~~</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is started \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">started_on</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is started \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~completedOn~~</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is completed \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">completed_on</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is completed \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~errors~~</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of errors thrown by the build \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">errors_no</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of errors thrown by the build \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~warnings~~</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of warnings thrown by the build \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">warnings_no</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of warnings thrown by the build \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~log~~</span> \|\| string \|\| - \|\| YES \|\| - \|\| Path to log file \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">cooker_log_path</span> \|\| string \|\| - \|\| YES \|\| - \|\| Path to log file \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">~~output~~</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The extensions of the root file systems produced by the build \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">image_fstypes</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The extensions of the root file systems produced by the build \|\| -
	\|}		\|}

Ciprian Pratia at 10:03, 23 July 2013

2013-07-23T10:03:18Z

← Older revision		Revision as of 10:03, 23 July 2013
Line 39:		Line 39:
	\| [Object Root].<span style="color:#006600">list</span> \|\| object array \|\| - \|\| YES \|\| - \|\| - \|\| To describe a generic object element of the array,<br /> the refference to it's root is "list[]"		\| [Object Root].<span style="color:#006600">list</span> \|\| object array \|\| - \|\| YES \|\| - \|\| - \|\| To describe a generic object element of the array,<br /> the refference to it's root is "list[]"
	\|-		\|-
	\| [Object Root].<span style="color:#~~006600~~">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#~~006600~~">list[]</span>.<span style="color:#0066FF">string</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">string</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#~~006600~~">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> \|\| number \|\| 2 \|\| YES \|\| - \|\| Signals successful or failed build \|\| 0 - the build has failed,<br /> 1 - successful build		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> \|\| number \|\| 2 \|\| YES \|\| - \|\| Signals successful or failed build \|\| 0 - the build has failed,<br /> 1 - successful build

Ciprian Pratia at 10:02, 23 July 2013

2013-07-23T10:02:36Z

← Older revision		Revision as of 10:02, 23 July 2013
Line 39:		Line 39:
	\| [Object Root].<span style="color:#006600">list</span> \|\| object array \|\| - \|\| YES \|\| - \|\| - \|\| To describe a generic object element of the array,<br /> the refference to it's root is "list[]"		\| [Object Root].<span style="color:#006600">list</span> \|\| object array \|\| - \|\| YES \|\| - \|\| - \|\| To describe a generic object element of the array,<br /> the refference to it's root is "list[]"
	\|-		\|-
	\| [Object Root].<span style="color:#~~FF9900~~">list[]</span>.<span style="color:#~~006600~~">~~outcome~~</span> \|\| number \|\| 2 \|\| YES \|\| - \|\| ~~Signals successful or failed build~~ \|\| ~~0 - the build has failed,<br /> 1~~ - ~~successful build~~		\| [Object Root].<span style="color:#006600">list[]</span>.<span style="color:#0066FF">pk</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#~~FF9900~~">list[]</span>.<span style="color:#~~006600~~">~~target~~</span> \|\| ~~string~~ \|\| - \|\| YES \|\| - \|\| ~~The name of the build target(s)~~ \|\| -		\| [Object Root].<span style="color:#006600">list[]</span>.<span style="color:#0066FF">string</span> \|\| number \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#~~FF9900~~">list[]</span>.<span style="color:#~~006600~~">~~machine~~</span> \|\| ~~string array~~ \|\| - \|\| YES \|\| - \|\| ~~The selected hardware~~ \|\| -		\| [Object Root].<span style="color:#006600">list[]</span>.<span style="color:#0066FF">fields</span> \|\| object \|\| - \|\| YES \|\| - \|\| - \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">~~startedOn~~</span> \|\| number ~~representation of date~~ \|\| - \|\| YES \|\| - \|\| ~~Marks the moment the process is started~~ \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">outcome</span> \|\| number \|\| 2 \|\| YES \|\| - \|\| Signals successful or failed build \|\| 0 - the build has failed,<br /> 1 - successful build
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">~~completedOn~~</span> \|\| ~~number representation of date~~ \|\| - \|\| YES \|\| - \|\| ~~Marks the moment~~ the ~~process is completed~~ \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">target</span> \|\| string \|\| - \|\| YES \|\| - \|\| The name of the build target(s) \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">~~errors~~</span> \|\| ~~number~~ \|\| - \|\| YES \|\| - \|\| ~~Number of errors thrown by the build~~ \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">machine</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The selected hardware \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">~~warnings~~</span> \|\| number \|\| - \|\| YES \|\| - \|\| ~~Number of warnings thrown by~~ the ~~build~~ \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">startedOn</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is started \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">~~log~~</span> \|\| ~~string~~ \|\| - \|\| YES \|\| - \|\| ~~Path to log file~~ \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">completedOn</span> \|\| number representation of date \|\| - \|\| YES \|\| - \|\| Marks the moment the process is completed \|\| -
	\|-		\|-
	\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#006600">output</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The extensions of the root file systems produced by the build \|\| -		\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">errors</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of errors thrown by the build \|\| -
			\|-
			\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">warnings</span> \|\| number \|\| - \|\| YES \|\| - \|\| Number of warnings thrown by the build \|\| -
			\|-
			\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">log</span> \|\| string \|\| - \|\| YES \|\| - \|\| Path to log file \|\| -
			\|-
			\| [Object Root].<span style="color:#FF9900">list[]</span>.<span style="color:#0066FF">fields</span>.<span style="color:#006600">output</span> \|\| string array \|\| - \|\| YES \|\| - \|\| The extensions of the root file systems produced by the build \|\| -
	\|}		\|}

Ciprian Pratia at 09:51, 23 July 2013

2013-07-23T09:51:55Z

← Older revision		Revision as of 09:51, 23 July 2013
Line 20:		Line 20:
	\| 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		\| 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 \|\| The general form: "<FIELD>:<~~ASC/DESC~~>". If field ~~= freeText, "freeText:<SEARCH_STRING>"~~.		\| 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. \|\| -
	\|}		\|}