SpiraPlan: REST Web Service (v5.0)

See all operations

POST: projects/{project_id}/releases/{release_id}/builds

Description

Creates a new build in the system, including any linked source code revisions

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

https://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects/{project_id}/releases/{release_id}/builds

Request Parameters

Name Description
project_id The id of the project
release_id The id of the release

Request Body

Property Description
BuildId The id of the build
BuildStatusId The id of the status of the build (1=Failed, 2=Passed)
ProjectId The id of the project the build belongs to
ReleaseId The id of the release or iteration the build belongs to
Name The name of the build
Description The detailed description of the host Optional
LastUpdateDate The date/time that the build was last modified
CreationDate The date the build was created Pass null to use the current server date/time
BuildStatusName The display name of the status of the build Read-only
Revisions The list of source code revisions associated with the build

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
BuildId The id of the build
BuildStatusId The id of the status of the build (1=Failed, 2=Passed)
ProjectId The id of the project the build belongs to
ReleaseId The id of the release or iteration the build belongs to
Name The name of the build
Description The detailed description of the host Optional
LastUpdateDate The date/time that the build was last modified
CreationDate The date the build was created Pass null to use the current server date/time
BuildStatusName The display name of the status of the build Read-only
Revisions The list of source code revisions associated with the build