Skip to content

Project service

Tom Birras edited this page Dec 1, 2020 · 6 revisions

This service handles all kinds of requests regarding Bamboo projects.
The following functions are available:

GetAllProjects()

Gets all projects that are currently available on Bamboo.

Optional request parameter Description
WithMaxResult(int maxResult) Limits the maximum amount of returned results
StartAtIndex(int startIndex) Starting index of result list (zero-based)
IncludeEmptyProjects() Also projects without any plan will be returned
IncludePlanInformation() Include additional information about containing plans, otherwise they are empty

GetInformationOfProject(string projectKey)

Returns some more detailed information about a single project.

projectKey - Unique key that identifies the project

Optional request parameter Description
WithMaxResult(int maxResult) Limits the maximum amount of returned plan information
StartAtIndex(int startIndex) Starting index of plan information list (zero-based)
IncludePlanInformation() Include additional information about containing plans, otherwise they are empty

CreateProject(string projectKey, string projectName)

Creates a new Bamboo project.

projectKey - Unique key that identifies the new project (must not exist before)
projectName - The name of the project

Optional request parameter Description
WithDescription(string description) Adds a description to the project
EnablePublicAccess() Your project will also have public access

DeleteProject(string projectKey)

Deletes an existing project on Bamboo.

projectKey - Unique key that identifies the project

Clone this wiki locally