Web Service API

FinalBuilder Server exposes a web service which can be used to programmatically control builds.

The URL to the web service is [build_machine]/Services/FinalBuilderServer.asmx, where [build_machine] is the URL to machine hosting FinalBuilder Server, including the virtual directory if applicable.

Their are currently 8 operations which are supported:

Authenticate

Authenticates the specified username and password and returns an authentication token (GUID String) which can be passed into other web service operations.

Parameters:

Username - string

Password - string

Returns:

Authentication Token - string

Create User

Creates a new standard user on the build machine with the specified parameters.

Parameters:

Authentication Token - string

Username - string

Password - string

Name - string

Email - string

Roles - array of string

Get Project Names

Gets the names of all projects on the server which the authenticated user has access to.

Parameters:

Authentication Token - string

Returns:

Project Names - array of string

Get Project Status

Gets the current status of the specified project.

Parameters:

Authentication Token - string

Project Name - string

Returns:

 Project Status - ProjectStatus [NeverRun, Running, Failure, Success, ConfigurationError, Stopping, Terminating, Terminated, Suspended]

Get Project Trigger Log

Gets the trigger log of the specified project.

Parameters:

Authentication Token - string

Project Name - string

Returns:

Trigger Log - array of string

Start Project

Adds the specified project to the build queue.

Parameters:

Authentication Token - string

Project Name - string

Start Project With Variables

Adds the project to the build queue with the variable values specified. Variables to be specified in format 'VariableName=VariableValue'

Parameters:

Authentication Token - string

Project Name - string

Variables - array of String

Stop Project

Stops the specified project if it is currently running.

Parameters:

Authentication Token - string

Project Name - string

User Exists

Checks whether the specified user exists.

Parameters:

Username - string

Returns:

Result - boolean