library/com.gabrielfeo.develocity.api/ProjectsApi

ProjectsApi

Functions

@PUT(value = "api/projects/{projectId}")

abstract suspend fun createOrUpdateProject(@Path(value = "projectId") projectId: String, @Body project: Project): Project

Create or update a project. <mark>Beta:</mark> Create a new project in Develocity or update an existing project. When updating, any optional fields that are omitted from the request, but were previously set on the project, will be unset/removed. An existing project's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response. Responses:

createOrUpdateProjectGroup

@PUT(value = "api/project-groups/{projectGroupId}")

abstract suspend fun createOrUpdateProjectGroup(@Path(value = "projectGroupId") projectGroupId: String, @Body projectGroup: ProjectGroup): ProjectGroup

Create or update a project group. <mark>Beta:</mark> Create a new project group in Develocity or update an existing project group. When updating, any optional fields that are omitted from the request, but were previously set on the project group, will be unset/removed. An existing project group's identifier cannot be updated. If the update contains a id that does not match the current id, then the operation will fail with a Bad Request response. Responses:

deleteProjectGroup

@DELETE(value = "api/project-groups/{projectGroupId}")

abstract suspend fun deleteProjectGroup(@Path(value = "projectGroupId") projectGroupId: String)

Delete a project group. <mark>Beta:</mark> Delete a project group. Responses:

getProject

@GET(value = "api/projects/{projectId}")

abstract suspend fun getProject(@Path(value = "projectId") projectId: String): Project

Get a project. <mark>Beta:</mark> Gets a specific project. Responses:

getProjectGroup

@GET(value = "api/project-groups/{projectGroupId}")

abstract suspend fun getProjectGroup(@Path(value = "projectGroupId") projectGroupId: String): ProjectGroup

Get a project group <mark>Beta:</mark> Gets a specific project group. Responses:

listProjectGroups

@GET(value = "api/project-groups")

abstract suspend fun listProjectGroups(@Query(value = "pageNumber") pageNumber: Int? = 0, @Query(value = "pageSize") pageSize: Int? = null): ProjectGroupsPage

Lists project groups. <mark>Beta:</mark> Returns a list of all project groups. If there are a lot of project groups, then all pages will need to be retrieved in order to retrieve the full list of project groups. The default number of project groups per page is 100. Responses:

listProjects

@GET(value = "api/projects")

abstract suspend fun listProjects(@Query(value = "pageNumber") pageNumber: Int? = 0, @Query(value = "pageSize") pageSize: Int? = null): ProjectsPage

Lists Projects. <mark>Beta:</mark> Returns a paged list of all projects. If there are a lot of projects, then all pages will need to be retrieved in order to retrieve the full list of projects. The default number of projects per page is 1,000. Responses: