Projects

Create project

post /api/http/projects

Create a new project

Rights, that may be checked: Create projects

Request arguments

object with fields:

key: ProjectKey
name: string
description: string ( Nullable and Optional , defaults to null)
private: boolean ( Optional , defaults to false)
tags: array of string ( Optional , defaults to [])

Response
`PR_Project`

Get all projects

get /api/http/projects

Get/search all projects. Parameters are applied as ' AND ' filters.

Request arguments
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`term`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`tag`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`starred`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get all projects by collaborator

get /api/http/projects/collaborator:{profile}

Get all projects in which given user is a collaborator

Request arguments

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get all projects by member

get /api/http/projects/member:{member}

Get all projects for a member

Request arguments

member: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get all projects with right

get /api/http/projects/right-code:{rightCode}

Request arguments
`rightCode`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`term`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`path`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`starred`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get all projects with right code

get /api/http/projects/right-unique-code:{right}

Request arguments
`right`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`term`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`path`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`starred`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get all projects by team

get /api/http/projects/team:{team}

Get all projects for a team

Request arguments
`team`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PR_Project

Get project

get /api/http/projects/{project}

Get project by ID or project key

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
`PR_Project`

Update project

patch /api/http/projects/{project}

Update an existing project. Optional parameters will be ignored when not specified and updated otherwise.

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

key: ProjectKey ( Nullable and Optional , defaults to null)
name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
private: boolean ( Nullable and Optional , defaults to null)
tags: array of string ( Nullable and Optional , defaults to null)
icon: string ( Nullable and Optional )

Response
`PR_Project`

Delete project

delete /api/http/projects/{project}

Delete a project

Rights, that may be checked: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
No arguments

Get dsl evaluation configuration

get /api/http/projects/automation/dsl-evaluations/config

Request arguments
No arguments

Response
`DslEvaluationConfig`

Stop execution

post /api/http/projects/automation/graph-executions/{id}/stop

Stop execution by ExecutionId

Rights, that may be checked: Stop automation jobs

Request arguments
`id`: `string` (Path)

Response
No arguments

Get graph execution

get /api/http/projects/automation/graph-executions/{id}

Rights, that may be checked: View automation jobs

Request arguments
`id`: `string` (Path)

Response
`JobExecutionDTO`

Get current

get /api/http/projects/automation/job-executions/current

Rights, that may be checked: View automation jobs

Request arguments
No arguments

Response
`JobExecutionDTO`

Get job

get /api/http/projects/automation/jobs/{jobId}

Rights, that may be checked: View automation jobs

Request arguments

jobId: string (Path)

project: string in one of the formats

id: string
key: string

(Query)

Response
`JobDTO`

Get param

get /api/http/projects/automation/step-executions/used-parameters/param/{parameterId}

Request arguments
`parameterId`: `string` (Path)

Response
array of `ParameterLastUsageDTO`

Get secret

get /api/http/projects/automation/step-executions/used-parameters/secret/{secretId}

Request arguments
`secretId`: `string` (Path)

Response
array of `ParameterLastUsageDTO`

Get parameter

get /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}

Request arguments
`stepExecId`: `string` (Path)
`key`: `string` (Path)

Response
`string`

Update parameter

patch /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}

Request arguments

stepExecId: string (Path)

key: string (Path)

object with fields:

value: string

Response
No arguments

Delete parameter

delete /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}

Request arguments
`stepExecId`: `string` (Path)
`key`: `string` (Path)

Response
No arguments

Delete legacy channels

delete /api/http/projects/automation/subscriptions/legacy-channels

Delete the legacy subscription channels matching the given filters ( applied as AND ) . If no filter is provided, all subscription channels corresponding to unsubscribed jobs for the logged in user are deleted.

Request arguments

project: string in one of the formats

id: string
key: string

(Query) ( Nullable and Optional , defaults to null)

Only delete the channels of the subscriptions from this project

jobId: string (Query) ( Nullable and Optional , defaults to null)

Only delete the channels of the subscriptions from this job. You can find the job ID in the URL of the job page.

unsubscribedOnly: boolean (Query) ( Optional , defaults to true)

When true ( the default ) , only channels corresponding to unsubscribed subscriptions will be deleted, active subscriptions won ' t be affected

Response
No arguments

Update param

patch /api/http/projects/params/{id}

Update an existing project parameter

Rights, that may be checked: Modify project parameters

Request arguments

id: string (Path)

object with fields:

value: string
description: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete param

delete /api/http/projects/params/{id}

Delete an existing project parameter

Rights, that may be checked: Delete project parameters

Request arguments
`id`: `string` (Path)

Response
No arguments

Create default bundle (parameters)

post /api/http/projects/params/default-bundle

Create a new project parameter in the default parameter bundle

Rights, that may be checked: Modify project parameters

Request arguments

object with fields:

project: ProjectIdentifier
key: string
value: string
description: string ( Nullable and Optional , defaults to null)

Response
`string`

Get all default bundle (parameters)

get /api/http/projects/params/default-bundle

List project parameters in a parameter bundle

Rights, that may be checked: View project parameters

Request arguments

project: string in one of the formats

id: string
key: string

(Query)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PlainParameterRecord

Create in default bundle (parameters)

post /api/http/projects/params/in-default-bundle

Rights, that may be checked: Modify project parameters

Request arguments

object with fields:

projectId: string
key: string
value: string

Response
`string`

Get all in default bundle (parameters)

get /api/http/projects/params/in-default-bundle

List project parameters in a parameter bundle

Rights, that may be checked: View project parameters

Request arguments
`projectId`: `string` (Query)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PlainParameterRecord

Get board

get /api/http/projects/planning/boards/{board}

Get a board by identifier

Rights, that may be checked: View boards

Request arguments

board: string in one of the formats

id: string

(Path)

Response
`BoardRecord`

Update board

patch /api/http/projects/planning/boards/{board}

Update an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

board: string in one of the formats

id: string

(Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional )
swimlaneKey: string ( Nullable and Optional )
columns: BoardColumns ( Nullable and Optional , defaults to null)
issueFields: array of BoardIssueInputField ( Nullable and Optional , defaults to null)
memberOwners: array of string ( Nullable and Optional , defaults to null)
teamOwners: array of string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete board

delete /api/http/projects/planning/boards/{board}

Delete an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

board: string in one of the formats

id: string

(Path)

Response
No arguments

Create sprint

post /api/http/projects/planning/boards/sprints

Create a new sprint in a board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

object with fields:

board: BoardIdentifier
name: string
description: string ( Nullable and Optional , defaults to null)
from: string (format: full-date)
to: string (format: full-date)
launch: SprintLaunch ( Optional )

Response
`SprintRecord`

Launch planned sprint

post /api/http/projects/planning/boards/sprints/{sprint}/launch

Launch a planned sprint. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path)

object with fields:

moveUnresolvedIssuesFromCurrentSprint: boolean
notifySubscribers: boolean ( Optional , defaults to true)

Response
No arguments

Update sprint

patch /api/http/projects/planning/boards/sprints/{sprint}

Update an existing sprint in a board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional )
from: string (format: full-date) ( Nullable and Optional , defaults to null)
to: string (format: full-date) ( Nullable and Optional , defaults to null)
launch: SprintLaunch ( Nullable and Optional , defaults to null)

Response
No arguments

Archive sprint

delete /api/http/projects/planning/boards/sprints/{sprint}/archive

Archive closed or planned sprint. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path)

Response
No arguments

Add issue to sprint

post /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}

Add an existing issue in a project to a sprint

Rights, that may be checked: Manage issue assignment

Request arguments

issue: string in one of the formats

id: string
key: string

(Path)

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path)

Response
No arguments

Remove issue from sprint

delete /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}

Remove an existing issue in a project from a sprint.

Rights, that may be checked: Manage issue assignment

Request arguments

issue: string in one of the formats

id: string
key: string

(Path)

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path)

Response
No arguments

Get all issues in sprint

get /api/http/projects/planning/boards/sprints/{sprint}/issues

Fetch issues from an existing non-archived sprint

Rights, that may be checked: View boards

Request arguments
`sprint`: string in one of the formats `board`: `BoardIdentifier` `id`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`unresolvedOnly`: `boolean` (Query) ( Optional , defaults to `false`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of Issue

Add issue to board

post /api/http/projects/planning/boards/{board}/issues/{issue}

Add an existing issue in a project to a board or its current sprint

Rights, that may be checked: Manage issue assignment

Request arguments

issue: string in one of the formats

id: string
key: string

(Path)

board: string in one of the formats

id: string

(Path)

Response
No arguments

Remove issue from board

delete /api/http/projects/planning/boards/{board}/issues/{issue}

Remove an existing issue in a project from a board or all of its sprints

Rights, that may be checked: Manage issue assignment

Request arguments

issue: string in one of the formats

id: string
key: string

(Path)

board: string in one of the formats

id: string

(Path)

Response
No arguments

Get all issues on board

get /api/http/projects/planning/boards/{board}/issues

Fetch issues from the board across all its non-archived sprints

Rights, that may be checked: View boards

Request arguments

board: string in one of the formats

id: string

(Path)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of Issue

Request access to project

post /api/http/projects/private-projects/{project}/request-access

Request access to a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
No arguments

Get all private projects

get /api/http/projects/private-projects

List private projects in the current organization

Request arguments
No arguments

Response
array of `PR_PrivateProject`

Get all find

get /api/http/projects/repositories/find

Request arguments
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`term`: `string` (Query)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of RepositoryDetails

Add responsibility

post /api/http/projects/responsibilities

Add a responsibility for a given subject ID

Request arguments

object with fields:

subjectId: string
summary: string
notes: string ( Nullable and Optional , defaults to null)

Response
`string`

Update responsibility

patch /api/http/projects/responsibilities/{responsibilityId}

Edit an existing responsibility

Request arguments

responsibilityId: string (Path)

object with fields:

summary: string
notes: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete responsibility

delete /api/http/projects/responsibilities/{responsibilityId}

Delete an existing responsibility

Request arguments
`responsibilityId`: `string` (Path)

Response
No arguments

Delete responsibility subject

delete /api/http/projects/responsibilities/subjects/{subjectId}

Delete an existing responsibility subject for a given project ID

Request arguments

subjectId: string (Path)

project: string in one of the formats

id: string
key: string

(Query) ( Nullable and Optional , defaults to null)

Response
No arguments

Update secret

patch /api/http/projects/secrets/{id}

Update an existing project secret

Rights, that may be checked: Update project secrets

Request arguments

id: string (Path)

object with fields:

valueBase64: string
publicKeyId: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete secret

delete /api/http/projects/secrets/{id}

Delete an existing project secret

Rights, that may be checked: Delete project secrets

Request arguments
`id`: `string` (Path)

Response
No arguments

Create default bundle (secrets)

post /api/http/projects/secrets/default-bundle

Create a new secret in the default parameter bundle. Value is base64 encoded bytes of the secret value, possibly after client side encryption. If the secret value bytes are encrypted then the id of the Space public key must be provided

Rights, that may be checked: Create project secrets

Request arguments

object with fields:

project: ProjectIdentifier
key: string
valueBase64: string
publicKeyId: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)

Response
`string`

Get all default bundle (secrets)

get /api/http/projects/secrets/default-bundle

List project secrets in a parameter bundle

Rights, that may be checked: View keys of project secrets

Request arguments

project: string in one of the formats

id: string
key: string

(Query)

$skip: string (Query) ( Nullable and Optional , defaults to null)

$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of SecretParameterRecord

Create in default bundle (secrets)

post /api/http/projects/secrets/in-default-bundle

Rights, that may be checked: Create project secrets

Request arguments

object with fields:

projectId: string
key: string
valueBase64: string
publicKeyId: string ( Nullable and Optional , defaults to null)

Response
`string`

Get all in default bundle (secrets)

get /api/http/projects/secrets/in-default-bundle

Rights, that may be checked: View keys of project secrets

Request arguments
`projectId`: `string` (Query)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of SecretParameterRecord

Track tag access

post /api/http/projects/tags/track-access

Track a tag has been accessed

Request arguments

object with fields:

tag: string

Response
No arguments

Get all tags

get /api/http/projects/tags

List all tags, mapped to the number of projects they are used in

Request arguments
No arguments

Response
array of `PR_Tag`

Create vault

post /api/http/projects/vault

Create a new Vault connection for the project. Vault ' s AppRole Secret Id must be provided as base64 encoded string

Rights, that may be checked: Modify Vault connections

Request arguments

object with fields:

project: ProjectIdentifier
url: string
name: string
namespace: string ( Nullable and Optional , defaults to null)
vaultNamespace: string ( Nullable and Optional , defaults to null)
appRoleEndpointPath: string
appRoleId: string
appRoleSecretIdBase64: string

Response
`string`

Get vault

get /api/http/projects/vault

Get an existing Vault connections for project

Rights, that may be checked: View Vault connections

Request arguments

project: string in one of the formats

id: string
key: string

(Query)

Response
array of `VaultConnectionRecord`

Update vault

patch /api/http/projects/vault/{id}

Update an existing Vault connection

Rights, that may be checked: Modify Vault connections

Request arguments

id: string (Path)

object with fields:

url: string
name: string
namespace: string ( Nullable and Optional , defaults to null)
vaultNamespace: string ( Nullable and Optional , defaults to null)
appRoleEndpointPath: string
appRoleId: string
appRoleSecretIdBase64: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete vault

delete /api/http/projects/vault/{id}

Delete an existing Vault connection

Rights, that may be checked: Delete Vault connections

Request arguments
`id`: `string` (Path)

Response
No arguments

Get all admins

get /api/http/projects/{project}/access/admins

Returns the list of all project administrators

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `TD_MemberProfile`

Add administrator

post /api/http/projects/{project}/access/admins/profiles

Add a member as administrator to a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

profile: ProfileIdentifier

Response
No arguments

Remove administrator

delete /api/http/projects/{project}/access/admins/profiles/{profile}

Remove a member as administrator from a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

Response
No arguments

Add administrators team

post /api/http/projects/{project}/access/admins/teams

Add a team as administrators to a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

teamId: string

Response
No arguments

Remove administrators team

delete /api/http/projects/{project}/access/admins/teams/{teamId}

Remove a team as administrators from a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

teamId: string (Path)

Response
No arguments

Get all collaborators' profiles

get /api/http/projects/{project}/access/collaborators

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `TD_MemberProfile`

Add a collaborator

post /api/http/projects/{project}/access/collaborators/profiles

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

profile: ProfileIdentifier

Response
No arguments

Get all individual collaborators

get /api/http/projects/{project}/access/collaborators/profiles

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `TD_MemberProfile`

Remove a collaborator

delete /api/http/projects/{project}/access/collaborators/profiles

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Query)

Response
No arguments

Add a collaborators' team

post /api/http/projects/{project}/access/collaborators/teams

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

teamId: string

Response
No arguments

Get all collaborators' teams

get /api/http/projects/{project}/access/collaborators/teams

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `TD_Team`

Remove a collaborators' team

delete /api/http/projects/{project}/access/collaborators/teams

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

teamId: string (Query)

Response
No arguments

Get all member profiles

get /api/http/projects/{project}/access/member-profiles

Get project members for a given project key

Rights, that may be checked: View project details

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`query`: `string` (Query) ( Optional , defaults to `""`)
`includingAdmins`: `boolean` (Query) ( Optional , defaults to `false`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of TD_MemberProfile

Add member

post /api/http/projects/{project}/access/members/profiles

Add a member to a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

profile: ProfileIdentifier

Response
No arguments

Remove member

delete /api/http/projects/{project}/access/members/profiles/{profile}

Remove a member from a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

Response
No arguments

Add team

post /api/http/projects/{project}/access/members/teams

Add a team to a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

teamId: string

Response
No arguments

Remove team

delete /api/http/projects/{project}/access/members/teams/{teamId}

Remove a team from a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

teamId: string (Path)

Response
No arguments

Organization profiles that can view the project

get /api/http/projects/{project}/access/viewers

Get organization members who can view a project

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`term`: `string` (Query)
`meOnTop`: `boolean` (Query) ( Optional , defaults to `false`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of TD_MemberProfile

Create

post /api/http/projects/{project}/automation/deployment-targets

Rights, that may be checked: Modify deployment targets

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

key: string
name: string
description: string
repositories: array of DeployTargetRepositoryDTO ( Optional , defaults to [])

Response
No arguments

List deployment targets

get /api/http/projects/{project}/automation/deployment-targets

Rights, that may be checked: View deployments

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`search`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortOrder`: `ColumnSortOrder` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of DeployTargetDTO

List favorites

get /api/http/projects/{project}/automation/deployment-targets/favorites

Rights, that may be checked: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

sortBy: string (Query) ( Nullable and Optional , defaults to null)

sortOrder: ColumnSortOrder (Query) ( Nullable and Optional , defaults to null)

Response
array of `DeployTargetRecord`

Get deployment target

get /api/http/projects/{project}/automation/deployment-targets/{identifier}

Rights, that may be checked: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

identifier: string in one of the formats

id: string
key: string

(Path)

Response
`DeployTargetRecord`

Update deployment target

put /api/http/projects/{project}/automation/deployment-targets/{identifier}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

identifier: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
description: string
repositories: array of DeployTargetRepositoryDTO
manualControl: boolean ( Optional , defaults to true)
hangTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)
failTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)

Response
No arguments

Delete deployment target

delete /api/http/projects/{project}/automation/deployment-targets/{identifier}

Rights, that may be checked: Modify deployment targets

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

identifier: string in one of the formats

id: string
key: string

(Path)

Response
No arguments

Fail

post /api/http/projects/{project}/automation/deployments/fail

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

targetIdentifier: TargetIdentifier

Response
`DeploymentRecord`

Finish

post /api/http/projects/{project}/automation/deployments/finish

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

targetIdentifier: TargetIdentifier
deploymentIdentifier: DeploymentIdentifier ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Schedule

post /api/http/projects/{project}/automation/deployments/schedule

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

targetIdentifier: TargetIdentifier
version: string ( Nullable and Optional , defaults to null)
scheduledStart: string (format: date-time) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Start

post /api/http/projects/{project}/automation/deployments/start

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

targetIdentifier: TargetIdentifier
deploymentIdentifier: DeploymentIdentifier ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)
syncWithAutomationJob: boolean ( Optional , defaults to false)

Response
`DeploymentRecord`

List deployments

get /api/http/projects/{project}/automation/deployments

Rights, that may be checked: View deployments

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`targetIdentifier`: string in one of the formats `id`: `string` `key`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`jobExecutionId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of DeploymentRecord

Update deployment

put /api/http/projects/{project}/automation/deployments

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

targetIdentifier: TargetIdentifier
deploymentIdentifier: DeploymentIdentifier
version: string ( Nullable and Optional , defaults to null)
scheduledStart: string (format: date-time) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Get deployment

get /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}

Rights, that may be checked: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

targetIdentifier: string in one of the formats

id: string
key: string

(Path)

deploymentIdentifier: string in one of the formats

id: string
status: DeploymentIdentifierStatus
version: string

(Path)

Response
`DeploymentRecord`

Delete deployment

delete /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}

Rights, that may be checked: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

targetIdentifier: string in one of the formats

id: string
key: string

(Path)

deploymentIdentifier: string in one of the formats

id: string
status: DeploymentIdentifierStatus
version: string

(Path)

Response
No arguments

Get all graph executions

get /api/http/projects/{project}/automation/graph-executions

Search executions. Parameters are applied as ' AND ' filters.

Rights, that may be checked: View automation jobs

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`jobId`: `string` (Query)
`branchFilter`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`statusFilter`: `ExecutionStatus` (Query) ( Nullable and Optional , defaults to `null`)
`jobTriggerFilter`: `JobTriggerType` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of JobExecutionDTO

Start job

post /api/http/projects/{project}/automation/jobs/{jobId}/start

Start job. Returns ExecutionId, see projects/automation/graph-executions/{id}.

Rights, that may be checked: Start automation jobs

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

jobId: string (Path)

object with fields:

branch: Branch
parameters: array of JobParameter ( Nullable and Optional , defaults to null)

Response
`LaunchResult`

Get all jobs

get /api/http/projects/{project}/automation/jobs

List jobs. Parameters are applied as ' AND ' filters.

Rights, that may be checked: View automation jobs

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repoFilter`: `string` (Query)
`branchFilter`: `string` (Query)
`trigger`: `JobTriggerType` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of JobDTO

Create code discussion

post /api/http/projects/{project}/code-reviews/code-discussions

Rights, that may be checked: Create suggested edit

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

text: string
diffContext: DiffContext ( Nullable and Optional , defaults to null)
repository: string
revision: string
filename: string ( Nullable and Optional , defaults to null)
line: integer (format: int32) ( Nullable and Optional , defaults to null)
oldLine: integer (format: int32) ( Nullable and Optional , defaults to null)
pending: boolean ( Optional , defaults to false)
reviewId: ReviewIdentifier ( Nullable and Optional , defaults to null)

Response
`CodeDiscussionRecord`

Create review based on commit set

post /api/http/projects/{project}/code-reviews/commit-set-review

Rights, that may be checked: Create code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

repository: string
revisions: array of string
title: string ( Nullable and Optional , defaults to null)
authorProfileIds: array of string ( Nullable and Optional , defaults to null)

Response
`CommitSetReviewRecord`

Create merge request

post /api/http/projects/{project}/code-reviews/merge-requests

Rights, that may be checked: Create code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

repository: string
sourceBranch: string
targetBranch: string
title: string
reviewers: array of ReviewerParam ( Nullable and Optional , defaults to null)

Response
`MergeRequestRecord`

Get all code reviews

get /api/http/projects/{project}/code-reviews

Rights, that may be checked: View code reviews

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`state`: `CodeReviewStateFilter` (Query) ( Nullable and Optional , defaults to `"Opened"`)
`text`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`author`: string in one of the formats `externalId`: `string` `id`: `string` `me` `username`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`from`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`to`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`sort`: `ReviewSorting` (Query) ( Optional , defaults to `"CreatedAtAsc"`)
`reviewer`: string in one of the formats `externalId`: `string` `id`: `string` `me` `username`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`type`: `ReviewType` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of CodeReviewWithCount

Get code review

get /api/http/projects/{project}/code-reviews/{reviewId}

Rights, that may be checked: View code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

Response
`CodeReviewRecord`

Get review details

get /api/http/projects/{project}/code-reviews/{reviewId}/details

Rights, that may be checked: View code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

Response
`CodeReviewDetailedInfo`

Get the modified files in code review

get /api/http/projects/{project}/code-reviews/{reviewId}/files

Rights, that may be checked: View code reviews

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`reviewId`: string in one of the formats `id`: `string` `key`: `string` `number`: `integer` (format: int32) (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of ChangeInReview

Get the merge request files

get /api/http/projects/{project}/code-reviews/{reviewId}/merge-files

Rights, that may be checked: View code reviews

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`reviewId`: string in one of the formats `id`: `string` `key`: `string` `number`: `integer` (format: int32) (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of GitMergedFile

Get suggested reviewers

get /api/http/projects/{project}/code-reviews/{reviewId}/suggested-reviewers

Rights, that may be checked: View code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

Response
array of `TD_MemberProfile`

Get unread revisions

get /api/http/projects/{project}/code-reviews/{reviewId}/unread-revisions

Rights, that may be checked: View code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

Response
array of `ReviewCommitIn`

Edit review state

patch /api/http/projects/{project}/code-reviews/{reviewId}/state

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

object with fields:

state: CodeReviewState

Response
No arguments

Edit review title

patch /api/http/projects/{project}/code-reviews/{reviewId}/title

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

object with fields:

title: string

Response
No arguments

Merge a merge request

put /api/http/projects/{project}/code-reviews/{reviewId}/merge

Rights, that may be checked: View code reviews, Write Git repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

object with fields:

deleteSourceBranch: boolean
mergeMode: GitMergeMode

Response
`GitMergeResultHttp`

Rebase a merge request

put /api/http/projects/{project}/code-reviews/{reviewId}/rebase

Rights, that may be checked: View code reviews, Write Git repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

object with fields:

deleteSourceBranch: boolean
rebaseMode: GitRebaseMode
squash: boolean
squashedCommitMessage: string ( Nullable and Optional , defaults to null)

Response
`GitRebaseResultHttp`

Add review participant

post /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

user: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

object with fields:

role: CodeReviewParticipantRole

Response
No arguments

Remove review participant

delete /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

user: string in one of the formats

externalId: string
id: string
me
username: string

(Path)

role: CodeReviewParticipantRole (Query)

Response
No arguments

Add revisions to review

post /api/http/projects/{project}/code-reviews/{reviewId}/revisions

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

object with fields:

revisions: array of ReviewCommitIn

Response
No arguments

Remove revisions from review

delete /api/http/projects/{project}/code-reviews/{reviewId}/revisions

Rights, that may be checked: Edit code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

reviewId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path)

revisions: array of string (Query)

Response
No arguments

Create document

post /api/http/projects/{project}/documents

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
folder: FolderIdentifier
bodyIn: DocumentBodyCreateIn
publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional , defaults to null)

Response
`Document`

Get document

get /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

Response
`Document`

Update document

patch /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
updateIn: DocumentBodyUpdateIn ( Nullable and Optional , defaults to null)
publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional )

Response
`Document`

Archive document

delete /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

Response
No arguments

Create folder

post /api/http/projects/{project}/documents/folders

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
parentFolder: FolderIdentifier

Response
`DocumentFolder`

Get folder

get /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

Response
`DocumentFolder`

Rename folder

patch /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

object with fields:

name: string

Response
No arguments

Archive folder

delete /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

Response
No arguments

List documents in folder

get /api/http/projects/{project}/documents/folders/{folder}/documents

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`folder`: string in one of the formats `id`: `string` `root` (Path)
`withArchived`: `boolean` (Query) ( Optional , defaults to `false`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`order`: `ColumnSortOrder` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of Document

Add folder introduction

patch /api/http/projects/{project}/documents/folders/{folder}/introduction/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

documentId: string (Path)

Response
No arguments

Remove folder introduction

delete /api/http/projects/{project}/documents/folders/{folder}/introduction

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

Response
No arguments

Move folder

patch /api/http/projects/{project}/documents/folders/{folder}/move

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

folder: string in one of the formats

id: string
root

(Path)

object with fields:

parentFolder: FolderIdentifier

Response
`DocumentFolder`

List subfolders

get /api/http/projects/{project}/documents/folders/{folder}/subfolders

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`folder`: string in one of the formats `id`: `string` `root` (Path)
`withArchived`: `boolean` (Query) ( Optional , defaults to `false`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`order`: `ColumnSortOrder` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of DocumentFolder

Copy document

post /api/http/projects/{project}/documents/{documentId}/copy

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

object with fields:

name: string
folder: FolderIdentifier

Response
`Document`

Delete document forever

delete /api/http/projects/{project}/documents/{documentId}/delete-forever

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

Response
No arguments

Move document

patch /api/http/projects/{project}/documents/{documentId}/move

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

object with fields:

folder: FolderIdentifier

Response
`Document`

Unarchive document

patch /api/http/projects/{project}/documents/{documentId}/unarchive

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

documentId: string (Path)

Response
`Document`

Create new package repository

post /api/http/projects/{project}/packages/repositories

Creates a new package repository for a given project ID

Rights, that may be checked: Create package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

type: string
name: string
description: string ( Nullable and Optional , defaults to null)
public: boolean ( Optional , defaults to false)
settings: ES_PackageRepositorySettings ( Nullable and Optional , defaults to null)
mode: PackageRepositoryMode ( Optional , defaults to "HOSTING")
connection: PackageRepositoryConnection ( Nullable and Optional , defaults to null)

Response
`ProjectPackageRepository`

Get repositories

get /api/http/projects/{project}/packages/repositories

Gets a list of package repositories for a given project ID

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

type: string (Query) ( Nullable and Optional , defaults to null)

query: string (Query) ( Nullable and Optional , defaults to null)

Response
array of `ProjectPackageRepository`

Get repository

get /api/http/projects/{project}/packages/repositories/{repository}

Gets a package repository for a given project ID by type and name

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

Response
`ProjectPackageRepository`

Update repository

patch /api/http/projects/{project}/packages/repositories/{repository}

Updates package repository settings for a given project ID

Rights, that may be checked: Admin package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
public: boolean ( Nullable and Optional , defaults to null)
cleanupEnabled: boolean ( Nullable and Optional , defaults to null)
settings: ES_PackageRepositorySettings ( Nullable and Optional , defaults to null)

Response
No arguments

Delete package repository

delete /api/http/projects/{project}/packages/repositories/{repository}

Removes package repository for a given project ID

Rights, that may be checked: Admin package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

Response
No arguments

Cleanup repository

post /api/http/projects/{project}/packages/repositories/{repository}/cleanup

Cleanup specified package repository

Rights, that may be checked: Admin package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

object with fields:

retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

Response
`PackagesExecutionResult`

Dry run repository cleanup

post /api/http/projects/{project}/packages/repositories/{repository}/cleanup/dry

Dry run of cleanup for specified package repository

Rights, that may be checked: Admin package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

object with fields:

retentionParams: RetentionPolicyParams

Response
`DryCleanupResults`

Get all remote repositories

get /api/http/projects/{project}/packages/repositories/{repository}/connections

Gets a list of remote package repositories for given project

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

Response
array of `PackageRepositoryConnection`

Publish packages to remote repository

post /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish

Publishes packages to remote repository

Rights, that may be checked: Write package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

connectionId: string (Path)

object with fields:

source: PublishingSource

Response
`string`

Get list of publishing to remote repository

get /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish

Get list of publishing to remote repository

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`connectionId`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackagesPublishing

Get list of files

get /api/http/projects/{project}/packages/repositories/{repository}/files

Gets a list of repository files for a given project ID in parent folder

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

parentPath: string (Query) ( Nullable and Optional , defaults to null)

Response
array of `FileData`

Get file details

get /api/http/projects/{project}/packages/repositories/{repository}/files/name:{filePath}

Gets a details for repository file for a given project ID

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

filePath: string (Path)

Response
`FileDetails`

Delete file

delete /api/http/projects/{project}/packages/repositories/{repository}/files/name:{filePath}

Removes a file in repository for a given project ID

Rights, that may be checked: Write package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

filePath: string (Path)

Response
No arguments

Get all packages

get /api/http/projects/{project}/packages/repositories/{repository}/packages

Gets a list of repository packages for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`query`: `string` (Query)
`connectionId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackageData

Delete package

delete /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}

Removes all package versions in repository for a given project ID

Rights, that may be checked: Write package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

packageName: string (Path)

Response
No arguments

Get package metadata

get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata

Get package metadata in repository for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

packageName: string (Path)

Response
`PackageMetadata`

Report package metadata

put /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata

Update a package metadata in repository for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

packageName: string (Path)

object with fields:

connectionId: string ( Nullable and Optional , defaults to null)

Response
No arguments

Report package version metadata

put /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata/version:{packageVersion}

Report a package version metadata in repository for a given project ID

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`packageName`: `string` (Path)
`packageVersion`: `string` (Path)
object with fields: `pin`: `boolean` `comment`: `string` ( Nullable and Optional , defaults to `null`)

Response
No arguments

Get all package versions

get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions

Gets a list of repository package versions for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`packageName`: `string` (Path)
`query`: `string` (Query)
`connectionId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`pinned`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`sortColumn`: `PackagesSortColumn` (Query)
`sortOrder`: `ColumnSortOrder` (Query)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackageVersionData

Get package version details

get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}

Gets a details for repository package version for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`packageName`: `string` (Path)
`packageVersion`: `string` (Path)

Response
`PackageVersionDetails`

Delete package version

delete /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}

Removes a package version in repository for a given project ID

Rights, that may be checked: Write package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: string in one of the formats `id`: `string` `key`: `string` `{` `type`: `string` `, name`: `string` `}` (Path)
`packageName`: `string` (Path)
`packageVersion`: `string` (Path)

Response
No arguments

Get repository url

get /api/http/projects/{project}/packages/repositories/{repository}/url

Gets a package repository URL for a given project ID

Rights, that may be checked: Read package repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string in one of the formats

id: string
key: string
{ type: string , name: string }

(Path)

Response
`string`

Get all packages (deprecated)

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages

Gets a list of repository packages for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`type`: `string` (Path)
`repositoryName`: `string` (Path)
`query`: `string` (Query)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackageData

Get all package versions (deprecated)

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions

Gets a list of repository package versions for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`type`: `string` (Path)
`repositoryName`: `string` (Path)
`packageName`: `string` (Path)
`query`: `string` (Query)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`sortColumn`: `PackagesSortColumn` (Query)
`sortOrder`: `ColumnSortOrder` (Query)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackageVersionData

Get package version details (deprecated)

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}

Gets a details for repository package version for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`type`: `string` (Path)
`repositoryName`: `string` (Path)
`packageName`: `string` (Path)
`packageVersion`: `string` (Path)

Response
`PackageVersionDetails`

Delete package version (deprecated)

delete /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}

Removes a package version in repository for a given project ID

Rights, that may be checked: Write package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`type`: `string` (Path)
`repositoryName`: `string` (Path)
`packageName`: `string` (Path)
`packageVersion`: `string` (Path)

Response
No arguments

Find packages in repository

get /api/http/projects/{project}/packages/search

Executes a package search for a given project ID

Rights, that may be checked: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`type`: `string` (Query)
`query`: `string` (Query)
`connectionId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PackageVersionData

Get all types

get /api/http/projects/{project}/packages/types

Creates a new package repository for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `PackageType`

Create board

post /api/http/projects/{project}/planning/boards

Create a new issue board in a project. The user will become the owner of the board.

Rights, that may be checked: Create boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
description: string ( Nullable and Optional , defaults to null)

Response
`BoardRecord`

Get all boards

get /api/http/projects/{project}/planning/boards

Search existing boards in a project

Rights, that may be checked: View boards

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of BoardRecord

Get all sprints

get /api/http/projects/{project}/planning/boards/sprints

Search existing sprints in a project

Rights, that may be checked: View boards

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`board`: string in one of the formats `id`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of SprintRecord

Get all starred boards

get /api/http/projects/{project}/planning/boards/starred

Get all starred boards in a project

Rights, that may be checked: View boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `BoardRecord`

Archive board

delete /api/http/projects/{project}/planning/boards/{board}/archive

Archive an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Rights, that may be checked: Manage boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

board: string in one of the formats

id: string

(Path)

Response
No arguments

Create checklist

post /api/http/projects/{project}/planning/checklists

Create a new checklist in a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string

Response
`Checklist`

Get all checklists

get /api/http/projects/{project}/planning/checklists

Search existing checklists in a project

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sorting`: `ChecklistSorting` (Query) ( Optional , defaults to `"UPDATED"`)
`descending`: `boolean` (Query) ( Optional , defaults to `false`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of Checklist

Import checklist

post /api/http/projects/{project}/planning/checklists/import

Create a new checklist in a project using tab indented lines as checkable items. The items with the same indent level will be placed one under the other. An issue URL will be converted into the corresponding issue.

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
tabIndentedLines: string

Response
`Checklist`

Import checklist lines

post /api/http/projects/{project}/planning/checklists/{checklistId}/import

Tab indented lines are converted into checkable items following the same rules as in Import Checklist. The result is placed inside of the specified project checklist.

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

checklistId: string (Path)

object with fields:

targetParentId: string
afterItemId: string ( Nullable and Optional , defaults to null)
tabIndentedLines: string

Response
No arguments

Update checklist

patch /api/http/projects/{project}/planning/checklists/{checklistId}

Update an existing checklist in a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

checklistId: string (Path)

object with fields:

name: string ( Optional )
description: string ( Nullable and Optional )
owner: string ( Nullable and Optional )
tag: string ( Nullable and Optional )
topics: array of string ( Optional )

Response
No arguments

Delete checklist

delete /api/http/projects/{project}/planning/checklists/{checklistId}

Delete an existing checklist in a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

checklistId: string (Path)

Response
No arguments

Get all starred checklists

get /api/http/projects/{project}/planning/checklists/starred

Get all starred checklists in a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `Checklist`

Get full checklist tree

get /api/http/projects/{project}/planning/checklists/{checklistId}/full-checklist-tree

Get the content of a checklist in a project

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

checklistId: string (Path)

Response
array of `PlanItemChildren`

Create issue

post /api/http/projects/{project}/planning/issues

Create a new issue in a project

Rights, that may be checked: Create issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

title: string
description: string ( Nullable and Optional , defaults to null)
assignee: ProfileIdentifier ( Nullable and Optional , defaults to null)
status: string
dueDate: string (format: full-date) ( Nullable and Optional , defaults to null)
tags: array of string ( Optional , defaults to [])
checklists: array of string ( Optional , defaults to [])
sprints: array of SprintIdentifier ( Optional , defaults to [])
attachments: array of AttachmentIn ( Nullable and Optional , defaults to [])
fromMessage: MessageLink ( Nullable and Optional , defaults to null)
customFields: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)
topics: array of string ( Nullable and Optional , defaults to null)
parents: array of IssueIdentifier ( Nullable and Optional , defaults to null)

Response
`Issue`

Get all issues

get /api/http/projects/{project}/planning/issues

Search existing issues in a project. Parameters are applied as ' AND ' filters.

Rights, that may be checked: View issues

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`assigneeId`: array of `ProfileIdentifier` (Query) ( Optional , defaults to `[]`)
`createdByProfileId`: string in one of the formats `externalId`: `string` `id`: `string` `me` `username`: `string` (Query) ( Nullable and Optional , defaults to `null`) Deprecated since 2022-05-01: Use createdBy instead.
`createdBy`: array of `PrincipalIn` (Query) ( Optional , defaults to `[]`)
`statuses`: array of `string` (Query) ( Optional , defaults to `[]`)
`tagId`: `string` (Query) ( Nullable and Optional , defaults to `null`) Deprecated since 2021-09-02: Use tags instead.
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sorting`: `IssuesSorting` (Query)
`descending`: `boolean` (Query)
`tags`: array of `string` (Query) ( Optional , defaults to `[]`)
`sprints`: array of `SprintIdentifier` (Query) ( Optional , defaults to `[]`)
`boards`: array of `BoardIdentifier` (Query) ( Optional , defaults to `[]`)
`customFields`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`importTransaction`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`creationTimeFrom`: `string` (format: date-time) (Query) ( Nullable and Optional , defaults to `null`)
`creationTimeTo`: `string` (format: date-time) (Query) ( Nullable and Optional , defaults to `null`)
`dueDateFrom`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`dueDateTo`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`topics`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`grouping`: `IssueListGrouping` (Query) ( Nullable and Optional , defaults to `null`)
`deployment`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of Issue

Import issues

post /api/http/projects/{project}/planning/issues/import

Import issues in a project

Rights, that may be checked: Import issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

metadata: ImportMetadata
issues: array of ExternalIssue
assigneeMissingPolicy: ImportMissingPolicy ( Optional )
statusMissingPolicy: ImportMissingPolicy ( Optional )
onExistsPolicy: ImportExistsPolicy ( Optional )
dryRun: boolean
notifySubscribers: boolean ( Optional , defaults to false)
Deprecated since 2022-08-11: The option to notify subscribers during issue import is no longer supported.

Response
`IssueImportResult`

Restore issue

post /api/http/projects/{project}/planning/issues/{issueId}/restore

Restore an issue in a project

Rights, that may be checked: Restore issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

Response
No arguments

Toggle issue resolved status

post /api/http/projects/{project}/planning/issues/{issueId}/toggle-resolved

Toggle status of an existing issue between resolved and unresolved

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

resolved: boolean

Response
No arguments

Get issue by number

get /api/http/projects/{project}/planning/issues/number:{number}

Find an existing issue by a given number in a project

Rights, that may be checked: View issues

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`number`: `integer` (format: int32) (Path)
`resolveAlias`: `boolean` (Query) ( Optional , defaults to `false`)
`withDeleted`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)

Response
`Issue`

Get issue

get /api/http/projects/{project}/planning/issues/{issueId}

Rights, that may be checked: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

withDeleted: boolean (Query) ( Nullable and Optional , defaults to null)

Response
`Issue`

Update issue

patch /api/http/projects/{project}/planning/issues/{issueId}

Update an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

title: string ( Optional )
description: string ( Nullable and Optional )
assignee: string ( Nullable and Optional )
status: string ( Optional )
dueDate: string (format: full-date) ( Nullable and Optional )
customFields: array of CustomFieldInputValue ( Optional , defaults to [])
notifySubscribers: boolean ( Optional , defaults to true)

Response
No arguments

Delete issue

delete /api/http/projects/{project}/planning/issues/{issueId}

Delete an issue from a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

Response
No arguments

Get all issue statuses

get /api/http/projects/{project}/planning/issues/statuses

Get all existing issue statuses in a project

Rights, that may be checked: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `IssueStatus`

Update issue statuses list

patch /api/http/projects/{project}/planning/issues/statuses

Configure issue statuses in a project. The list must contain at least one resolved and one unresolved status.

Rights, that may be checked: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

statuses: array of IssueStatusData

Response
No arguments

Get auto update target issue status for merge request merge

get /api/http/projects/{project}/planning/issues/statuses/auto-update-on-merge-request-merge

Get target issue status for auto updating issues on linked merge request merge

Rights, that may be checked: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
`IssueStatus`

Set auto update target issue status for merge request merge

patch /api/http/projects/{project}/planning/issues/statuses/auto-update-on-merge-request-merge

Set target issue status for auto updating issues on linked merge request merge

Rights, that may be checked: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

statusId: string ( Nullable and Optional , defaults to null)

Response
No arguments

Get issue status distribution

get /api/http/projects/{project}/planning/issues/statuses/distribution

Get all existing issue statuses with their usage, number of existing issues, in a project

Rights, that may be checked: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `IssueStatusWithUsages`

Add attachments

post /api/http/projects/{project}/planning/issues/{issueId}/attachments

Add attachments to an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

attachments: array of AttachmentIn

Response
No arguments

Remove attachments

delete /api/http/projects/{project}/planning/issues/{issueId}/attachments

Remove attachments from an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

identities: array of string (Query)

Response
No arguments

Add issue checklist

post /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}

Add the checklist to an existing issue in a project

Rights, that may be checked: Update issues, Edit documents

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string (Path)

checklistId: string (Path)

Response
No arguments

Remove issue checklist

delete /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}

Remove the checklist from an existing issue in a project

Rights, that may be checked: Update issues, Edit documents

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string (Path)

checklistId: string (Path)

Response
No arguments

Add code review links

post /api/http/projects/{project}/planning/issues/{issueId}/code-reviews

Add code review links to an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

codeReviewIds: array of ReviewIdentifier

Response
No arguments

Remove code review links

delete /api/http/projects/{project}/planning/issues/{issueId}/code-reviews

Remove code review links from an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

codeReviewIds: array of ReviewIdentifier (Query)

Response
No arguments

Import issue comment history

post /api/http/projects/{project}/planning/issues/{issueId}/comments/import

Rights, that may be checked: Import issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

comments: array of MessageForImport

Response
array of `string`

Add commit links

post /api/http/projects/{project}/planning/issues/{issueId}/commits

Add commit links to an existing issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

object with fields:

repository: string
commitIds: array of string

Response
No arguments

Remove commit links

delete /api/http/projects/{project}/planning/issues/{issueId}/commits

Remove commit links from an existing issue in a project

Rights, that may be checked: Update issues

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`issueId`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: `string` (Query)
`commitIds`: array of `string` (Query)

Response
No arguments

Add issue tag

post /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}

Add an existing tag to an issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

tagId: string (Path)

Response
No arguments

Remove issue tag

delete /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}

Remove an existing tag from an issue in a project

Rights, that may be checked: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

issueId: string in one of the formats

id: string
key: string

(Path)

tagId: string (Path)

Response
No arguments

Create hierarchical tag

post /api/http/projects/{project}/planning/tags

Create a new hierarchical tag in a project

Rights, that may be checked: Manage tags

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

parentTagId: string ( Nullable and Optional , defaults to null)
path: array of string

Response
`PlanningTag`

Get all hierarchical tags

get /api/http/projects/{project}/planning/tags

Search existing tags in a project

Rights, that may be checked: View project details

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of PlanningTag

Create new repository

post /api/http/projects/{project}/repositories/{repository}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string (Path)

object with fields:

description: string ( Optional , defaults to "")
defaultBranch: string ( Nullable and Optional , defaults to null)
initialize: boolean ( Optional , defaults to true)
defaultSetup: boolean ( Optional , defaults to false)

Response
`PR_RepositoryInfo`

Delete repository

delete /api/http/projects/{project}/repositories/{repository}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string (Path)

Response
No arguments

Commit changes to repository

post /api/http/projects/{project}/repositories/{repository}/commit

Request arguments

project: string (Path)

repository: string (Path)

object with fields:

baseCommit: string
targetBranch: string
commitMessage: string
files: array of GitCommitFileRequest

Response
`GitCommitResult`

Invoke garbage collection on repository [not available in multi-org mode]

post /api/http/projects/{project}/repositories/{repository}/gc

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string (Path)

Response
No arguments

List commits matching query

get /api/http/projects/{project}/repositories/{repository}/commits

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: `string` (Path)
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response

object with fields:

next: string
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of GitCommitInfo

Get repository git remote url

get /api/http/projects/{project}/repositories/{repository}/url

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string (Path)

Response
`RepositoryUrls`

Report external check status

post /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`repository`: `string` (Path)
`revision`: `string` (Path)
object with fields: `branch`: `string` ( Nullable and Optional , defaults to `null`) `changes`: array of `string` ( Nullable and Optional , defaults to `null`) `executionStatus`: `CommitExecutionStatus` `url`: `string` `externalServiceName`: `string` `taskName`: `string` `taskId`: `string` `timestamp`: `integer` (format: int64) ( Nullable and Optional , defaults to `null`) `description`: `string` ( Nullable and Optional , defaults to `null`)

Response
No arguments

Get external checks for a commit

get /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

repository: string (Path)

revision: string (Path)

Response
array of `ExternalCheckDTO`

Get project responsibility scheme

get /api/http/projects/{project}/responsibilities/scheme

Get the responsibilities schema for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `SubjectResponsibilitiesTable`

Add responsibility subject

post /api/http/projects/{project}/responsibilities/subjects

Add a responsibility subject for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)

Response
`string`

Edit responsibility subject

patch /api/http/projects/{project}/responsibilities/subjects/{subjectId}

Update an existing responsibility subject for a given project ID

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

subjectId: string (Path)

object with fields:

name: string ( Nullable and Optional , defaults to null)

Response
No arguments

Assign responsible

post /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}

Assign a responsible person for a given project ID and responsibility ID

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`responsibilityId`: `string` (Path)
`profileId`: `string` (Path)
object with fields: `role`: `string` ( Nullable and Optional , defaults to `null`)

Response
No arguments

Remove responsible

delete /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}

Remove a responsible person for a given project ID and responsibility ID

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path)
`responsibilityId`: `string` (Path)
`profileId`: `string` (Path)
`role`: `string` (Query) ( Nullable and Optional , defaults to `null`)

Response
No arguments

Create topic

post /api/http/projects/{project}/topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

name: string
parentTopicId: string ( Nullable and Optional , defaults to null)

Response
`Topic`

Get topic

get /api/http/projects/{project}/topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

Response
array of `Topic`

Remove topics

post /api/http/projects/{project}/topics/remove-topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

ids: array of string

Response
No arguments

Set responsible

post /api/http/projects/{project}/topics/set-responsible

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

object with fields:

topicId: string
responsible: array of ProfileIdentifier

Response
No arguments

Update topic

patch /api/http/projects/{project}/topics/{id}

Request arguments

project: string in one of the formats

id: string
key: string

(Path)

id: string (Path)

object with fields:

name: string ( Optional )
parentTopicId: string ( Nullable and Optional )

Response
`Topic`

Last modified: 28 September 2022